Skip to main content
An Object defines a kind of record, such as Workers or workspace equipment. This API discovers registered platform Objects and Objects created in your workspace. Worker is the first registered platform Object; more external resource types will follow. Objects are currently available to verified administrators in workspaces with Objects enabled. Creating a definition does not create records or attributes.

​
Attributes

​
string
Stable identifier for the definition, such as objt_example.
​
string
Always object_type.
​
string
Canonical key, such as worker or objects.equipment. Immutable after creation.
​
string
Name for one record, such as Equipment item.
​
string
Name for the collection, such as Equipment.
​
string
Icon used in object headers and lists, such as regular/laptop.
​
string | null
Optional explanation of what this Object is used for.
​
string | null
Owning workspace ID, or null for a platform Object.
​
string | null
The ID of the Attribute used for record labels, selected in Object configuration. An unset label or an empty value falls back to the record ID.