Contact
Contacts represent individual people in Lightfield. Contacts can be associated with one or more accounts.
Get contact field definitions
Create a contact
Update a contact
Retrieve a contact
List contacts
ModelsExpand Collapse
ContactCreateResponse = object { id, createdAt, fields, 2 more }
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]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: string or number or boolean or 2 moreThe field value, or null if unset.
The field value, or null if unset.
UnionMember3 = array of string or number or boolean or 2 more
UnionMember4 = map[string or number or boolean or 2 more]
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
ContactDefinitionsResponse = object { fieldDefinitions, objectType, relationshipDefinitions }
fieldDefinitions: map[object { description, label, typeConfiguration, 3 more } ]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.
Description of the field, or null.
Human-readable display name of the field.
typeConfiguration: map[string or number or boolean or 2 more]Type-specific configuration (e.g. select options, currency code).
Type-specific configuration (e.g. select options, currency code).
UnionMember3 = array of string or number or boolean or 2 more
UnionMember4 = map[string or number or boolean or 2 more]
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreData type of the field.
Data type of the field.
Unique identifier of the field definition.
true for fields that are not writable via the API (e.g. AI-generated summaries). false or absent for writable fields.
The object type these definitions belong to (e.g. account).
relationshipDefinitions: map[object { cardinality, description, label, 2 more } ]Map of relationship keys to their definitions.
Map of relationship keys to their definitions.
cardinality: "HAS_ONE" or "HAS_MANY"Whether this is a has_one or has_many relationship.
Whether this is a has_one or has_many relationship.
Description of the relationship, or null.
Human-readable display name of the relationship.
The type of the related object (e.g. account, contact).
Unique identifier of the relationship definition.
ContactListResponse = object { data, object, totalCount }
data: array of object { id, createdAt, fields, 2 more } Array of entity objects for the current page.
Array of entity objects for the current page.
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]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: string or number or boolean or 2 moreThe field value, or null if unset.
The field value, or null if unset.
UnionMember3 = array of string or number or boolean or 2 more
UnionMember4 = map[string or number or boolean or 2 more]
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
The object type, always "list".
Total number of entities matching the query.
ContactRetrieveResponse = object { id, createdAt, fields, 2 more }
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]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: string or number or boolean or 2 moreThe field value, or null if unset.
The field value, or null if unset.
UnionMember3 = array of string or number or boolean or 2 more
UnionMember4 = map[string or number or boolean or 2 more]
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
ContactUpdateResponse = object { id, createdAt, fields, 2 more }
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]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: string or number or boolean or 2 moreThe field value, or null if unset.
The field value, or null if unset.
UnionMember3 = array of string or number or boolean or 2 more
UnionMember4 = map[string or number or boolean or 2 more]
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.