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
List custom object types
Get field value history for a custom object record
ModelsExpand Collapse
type ObjectCreateResponse struct{…}
Fields map[string, ObjectCreateResponseField]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.
Value ObjectCreateResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ObjectCreateResponseRelationship]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 ObjectCreateResponseRelationshipDirectionsOptionalDirectional 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.
AsDestination ObjectCreateResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
type ObjectDefinitionsResponse struct{…}
FieldDefinitions map[string, ObjectDefinitionsResponseFieldDefinition]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.
TypeConfiguration ObjectDefinitionsResponseFieldDefinitionTypeConfigurationType-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.
HandleService stringOptionalSocial 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 []ObjectDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptionalAvailable 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 stringOptionalLifecycle 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 stringOptionalColor 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.
Icon stringOptionalIcon the option is displayed with, or null when none is set. Present only on $stage.
Icon the option is displayed with, or null when none is set. Present only on $stage.
ValueType stringData type of the field.
Data type of the field.
AIFillable stringOptionalWhether 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.
true for fields that are not writable via the API (e.g. AI-generated summaries, calculated fields). false or absent for writable fields.
RelationshipDefinitions map[string, ObjectDefinitionsResponseRelationshipDefinition]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.
Directions ObjectDefinitionsResponseRelationshipDefinitionDirectionsOptionalDirectional 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.
AsDestination ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
Key of the relationship group this relationship belongs to, as listed under relationshipGroupDefinitions. Absent when the relationship is not in a group.
Inverse ObjectDefinitionsResponseRelationshipDefinitionInverseOptionalHow the same relationship reads from the related object type.
How the same relationship reads from the related object type.
RelationshipGroupDefinitions map[string, ObjectDefinitionsResponseRelationshipGroupDefinition]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.
type ObjectDeleteResponse struct{…}
Fields map[string, ObjectDeleteResponseField]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.
Value ObjectDeleteResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ObjectDeleteResponseRelationship]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 ObjectDeleteResponseRelationshipDirectionsOptionalDirectional 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.
AsDestination ObjectDeleteResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
type ObjectFieldHistoryResponse struct{…}
Data []ObjectFieldHistoryResponseDataRecorded 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).
Value ObjectFieldHistoryResponseDataValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
type ObjectListResponse struct{…}
Data []ObjectListResponseDataArray of entity objects for the current page.
Array of entity objects for the current page.
Fields map[string, ObjectListResponseDataField]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.
Value ObjectListResponseDataFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ObjectListResponseDataRelationship]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 ObjectListResponseDataRelationshipDirectionsOptionalDirectional 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.
AsDestination ObjectListResponseDataRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ObjectListResponseDataRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ObjectRestoreResponse struct{…}
Fields map[string, ObjectRestoreResponseField]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.
Value ObjectRestoreResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ObjectRestoreResponseRelationship]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 ObjectRestoreResponseRelationshipDirectionsOptionalDirectional 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.
AsDestination ObjectRestoreResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ObjectRestoreResponseRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ObjectRetrieveResponseUnion interface{…}
type ObjectRetrieveResponseEntity struct{…}
Fields map[string, ObjectRetrieveResponseEntityField]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.
Value ObjectRetrieveResponseEntityFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ObjectRetrieveResponseEntityRelationship]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 ObjectRetrieveResponseEntityRelationshipDirectionsOptionalDirectional 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.
AsDestination ObjectRetrieveResponseEntityRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ObjectRetrieveResponseEntityRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ObjectRetrieveResponseRestricted struct{…}
Restricted ObjectRetrieveResponseRestrictedRestrictedPresent only on a record the caller may know exists but not read. Check for it before reading fields or relationships, which a restricted record does not carry.
Present only on a record the caller may know exists but not read. Check for it before reading fields or relationships, which a restricted record does not carry.
type ObjectUpdateResponse struct{…}
Fields map[string, ObjectUpdateResponseField]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.
Value ObjectUpdateResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ObjectUpdateResponseRelationship]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 ObjectUpdateResponseRelationshipDirectionsOptionalDirectional 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.
AsDestination ObjectUpdateResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.