The Company object

The Company object describes companies within your application. A new Company is created when it is submitted via the API or, if connected and mapped, via third party integrations (e.g. provisioning a new company after a sale). Companies may be updated in a similar fashion.

An id is auto-generated for each Company , but they can also have 1 or many keys , which serve as unique identifiers that can be referenced via the API or by other systems when creating, retrieving, or updating a Company in Schematic.

Attributes

id
string

Unique identifer generated by Schematic for the object.

name
string

The company’s name, which is displayable to Schematic users.

lastSeenAt
datetime

Datetime of last update to company data, or last event associated with company. Format is ISO 8601.

createdAt
datetime

Datetime on which the object was created. Format is ISO 8601.

updatedAt
datetime

Datetime of last update to company data. Format is ISO 8601.

environmentId
string

Unique identifier of Schematic environment the Company is associated with.

traits
dictionary

Set of key-value pairs that are associated with the company. This is useful for storing additional information in a structured format that can be queried or used in segmentation, metering, targeting, or filtering.

keys
dictionary

Set of key-value pairs that represent external, unique identifiers. This is useful for storing external system-generated identifers, for instance from your application, from Stripe, or from Salesforce. Companies can be referenced by their id or any key via the Schematic API or integration mapping.

Keys must be unique across all companies in Schematic.

plans
dictionary

Set of plans for which the company matches the plan audience rule.

Was this page helpful?