Object
Custom objects and relationships are available on Pro and Growth plans. Records can be fetched and manipulated via these endpoints, and definitions can be fetched to discover the available custom object types in the system.
Create a custom object record
Get a custom object record
Update a custom object record
Delete a custom object record
Restore a custom object record
List custom object records
Get definitions for a custom object type
Get field value history for a custom object record
ModelsExpand Collapse
class ObjectCreateResponse: …
fields: Dict[str, Fields]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
relationships: Dict[str, Relationships]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
directions: Optional[RelationshipsDirections]Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
class ObjectDefinitionsResponse: …
field_definitions: Dict[str, FieldDefinitions]Map of field keys to their definitions, including both system and custom fields.
Map of field keys to their definitions, including both system and custom fields.
When the field definition was archived, or null if active.
type_configuration: FieldDefinitionsTypeConfigurationType-specific configuration (e.g. select options, currency code). A key the field type does not support is absent; a supported key with nothing set is null.
Type-specific configuration (e.g. select options, currency code). A key the field type does not support is absent; a supported key with nothing set is null.
ISO 4217 3-letter currency code. Present on CURRENCY fields, absent on every other type.
Number of decimal places values carry, or null when none is set. Present on NUMBER and CURRENCY fields, absent on every other type.
handle_service: Optional[Literal["TWITTER", "LINKEDIN", "FACEBOOK", "INSTAGRAM"]]Social platform associated with this handle field, or null when none is set. Present on SOCIAL_HANDLE fields, absent on every other type.
Social platform associated with this handle field, or null when none is set. Present on SOCIAL_HANDLE fields, absent on every other type.
Whether this field accepts multiple values. Present on EMAIL, TELEPHONE and URL fields, absent on every other type.
options: Optional[List[FieldDefinitionsTypeConfigurationOption]]Available options. Always present on SINGLE_SELECT and MULTI_SELECT fields, as an empty list when there are none. Absent on every other type.
Available options. Always present on SINGLE_SELECT and MULTI_SELECT fields, as an empty list when there are none. Absent on every other type.
category: Optional[Literal["ACTIVE", "COMPLETED"]]Lifecycle group of the option, in-progress (ACTIVE) or done (COMPLETED), or null when none is set. Absent on selects whose options are not grouped.
Lifecycle group of the option, in-progress (ACTIVE) or done (COMPLETED), or null when none is set. Absent on selects whose options are not grouped.
color: Optional[Literal["RED", "ORANGE", "YELLOW", 7 more]]Color the option is displayed in, GRAY when none was chosen. Absent on selects whose options take no color.
Color the option is displayed in, GRAY when none was chosen. Absent on selects whose options take no color.
Forecast weighting of the option from 0 to 100, or null when none is set. Absent on selects whose options take no forecast.
ai_fillable: Optional[Literal["ON", "OFF", "SUGGEST"]]Whether AI fills this field automatically (ON), only suggests values (SUGGEST), or leaves it alone (OFF). Absent on built-in fields that have no id.
Whether AI fills this field automatically (ON), only suggests values (SUGGEST), or leaves it alone (OFF). Absent on built-in fields that have no id.
Instructions AI follows when filling this field, or null when none are set. Absent on built-in fields that have no id.
Formula a calculated field evaluates, with fields and relationships referenced by key. Null for fields that are not calculated. Absent on built-in fields that have no id.
relationship_definitions: Dict[str, RelationshipDefinitions]Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.
Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.
When the relationship definition was archived, or null if active.
directions: Optional[RelationshipDefinitionsDirections]Directional metadata for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional metadata for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Key of the relationship group this relationship belongs to, as listed under relationshipGroupDefinitions. Absent when the relationship is not in a group.
relationship_group_definitions: Dict[str, RelationshipGroupDefinitions]Map of relationship group keys to their definitions. A group collects relationships between the same two object types, such as the roles a contact can hold on an opportunity. Relationships name their group with groupKey.
Map of relationship group keys to their definitions. A group collects relationships between the same two object types, such as the roles a contact can hold on an opportunity. Relationships name their group with groupKey.
class ObjectDeleteResponse: …
fields: Dict[str, Fields]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
relationships: Dict[str, Relationships]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
directions: Optional[RelationshipsDirections]Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
class ObjectFieldHistoryResponse: …
data: List[Data]Recorded values for the field, newest first.
Recorded values for the field, newest first.
Human-readable rendering of the value (e.g. a select option label), suitable for display.
True for the record’s original value. Only set when the full history fits in the response (never on a truncated/paginated page).
class ObjectListResponse: …
data: List[Data]Array of entity objects for the current page.
Array of entity objects for the current page.
fields: Dict[str, DataFields]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
relationships: Dict[str, DataRelationships]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
directions: Optional[DataRelationshipsDirections]Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
class ObjectRestoreResponse: …
fields: Dict[str, Fields]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
relationships: Dict[str, Relationships]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
directions: Optional[RelationshipsDirections]Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
class Entity: …
fields: Dict[str, EntityFields]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
relationships: Dict[str, EntityRelationships]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
directions: Optional[EntityRelationshipsDirections]Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
class ObjectUpdateResponse: …
fields: Dict[str, Fields]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
relationships: Dict[str, Relationships]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.
directions: Optional[RelationshipsDirections]Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.