Contact
Contacts represent individual people in Lightfield. Contacts can be associated with one or more accounts.
Get contact field definitions
Get field value history
Update a contact
Retrieve a contact
Delete a contact
Restore a contact
ModelsExpand Collapse
type ContactCreateResponse struct{…}
Fields map[string, ContactCreateResponseField]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 ContactCreateResponseFieldValueUnionThe 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, ContactCreateResponseRelationship]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 ContactCreateResponseRelationshipDirectionsOptionalDirectional 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 ContactCreateResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactCreateResponseRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ContactDefinitionsResponse struct{…}
FieldDefinitions map[string, ContactDefinitionsResponseFieldDefinition]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 ContactDefinitionsResponseFieldDefinitionTypeConfigurationType-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 []ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptionalAvailable 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, ContactDefinitionsResponseRelationshipDefinition]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 ContactDefinitionsResponseRelationshipDefinitionDirectionsOptionalDirectional 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 ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceThe 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 ContactDefinitionsResponseRelationshipDefinitionInverseOptionalHow the same relationship reads from the related object type.
How the same relationship reads from the related object type.
RelationshipGroupDefinitions map[string, ContactDefinitionsResponseRelationshipGroupDefinition]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 ContactDeleteResponse struct{…}
Fields map[string, ContactDeleteResponseField]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 ContactDeleteResponseFieldValueUnionThe 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, ContactDeleteResponseRelationship]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 ContactDeleteResponseRelationshipDirectionsOptionalDirectional 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 ContactDeleteResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactDeleteResponseRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ContactFieldHistoryResponse struct{…}
Data []ContactFieldHistoryResponseDataRecorded 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 ContactFieldHistoryResponseDataValueUnionThe 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 ContactListResponse struct{…}
Data []ContactListResponseDataArray of entity objects for the current page.
Array of entity objects for the current page.
Fields map[string, ContactListResponseDataField]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 ContactListResponseDataFieldValueUnionThe 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, ContactListResponseDataRelationship]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 ContactListResponseDataRelationshipDirectionsOptionalDirectional 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 ContactListResponseDataRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactListResponseDataRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ContactRestoreResponse struct{…}
Fields map[string, ContactRestoreResponseField]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 ContactRestoreResponseFieldValueUnionThe 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, ContactRestoreResponseRelationship]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 ContactRestoreResponseRelationshipDirectionsOptionalDirectional 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 ContactRestoreResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactRestoreResponseRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ContactRetrieveResponseUnion interface{…}
type ContactRetrieveResponseEntity struct{…}
Fields map[string, ContactRetrieveResponseEntityField]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 ContactRetrieveResponseEntityFieldValueUnionThe 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, ContactRetrieveResponseEntityRelationship]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 ContactRetrieveResponseEntityRelationshipDirectionsOptionalDirectional 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 ContactRetrieveResponseEntityRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactRetrieveResponseEntityRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ContactRetrieveResponseRestricted struct{…}
Restricted ContactRetrieveResponseRestrictedRestrictedPresent 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 ContactUpdateResponse struct{…}
Fields map[string, ContactUpdateResponseField]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 ContactUpdateResponseFieldValueUnionThe 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, ContactUpdateResponseRelationship]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 ContactUpdateResponseRelationshipDirectionsOptionalDirectional 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 ContactUpdateResponseRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ContactUpdateResponseRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.