Contact

Contacts represent individual people in Lightfield. Contacts can be associated with one or more accounts.

Get contact field definitions

client.Contact.Definitions(ctx) (*ContactDefinitionsResponse, error)

GET/v1/contacts/definitions

Get field value history

client.Contact.FieldHistory(ctx, fieldKey, params) (*ContactFieldHistoryResponse, error)

GET/v1/contacts/{id}/fields/{fieldKey}/history

Create a contact

client.Contact.New(ctx, body) (*ContactCreateResponse, error)

POST/v1/contacts

Update a contact

client.Contact.Update(ctx, id, body) (*ContactUpdateResponse, error)

POST/v1/contacts/{id}

Retrieve a contact

client.Contact.Get(ctx, id) (*ContactRetrieveResponse, error)

GET/v1/contacts/{id}

List contacts

client.Contact.List(ctx, query) (*ContactListResponse, error)

GET/v1/contacts

Delete a contact

client.Contact.Delete(ctx, id, body) (*ContactDeleteResponse, error)

DELETE/v1/contacts/{id}

Restore a contact

client.Contact.Restore(ctx, id, body) (*ContactRestoreResponse, error)

POST/v1/contacts/{id}/restore

ModelsExpand Collapse

type ContactCreateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

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.

Value ContactCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactCreateResponseFieldValueArray []string

type ContactCreateResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactCreateResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactCreateResponseFieldValueTypeAddress ContactCreateResponseFieldValueType = "ADDRESS"

const ContactCreateResponseFieldValueTypeCheckbox ContactCreateResponseFieldValueType = "CHECKBOX"

const ContactCreateResponseFieldValueTypeCurrency ContactCreateResponseFieldValueType = "CURRENCY"

const ContactCreateResponseFieldValueTypeDatetime ContactCreateResponseFieldValueType = "DATETIME"

const ContactCreateResponseFieldValueTypeEmail ContactCreateResponseFieldValueType = "EMAIL"

const ContactCreateResponseFieldValueTypeFullName ContactCreateResponseFieldValueType = "FULL_NAME"

const ContactCreateResponseFieldValueTypeMarkdown ContactCreateResponseFieldValueType = "MARKDOWN"

const ContactCreateResponseFieldValueTypeMultiSelect ContactCreateResponseFieldValueType = "MULTI_SELECT"

const ContactCreateResponseFieldValueTypeNumber ContactCreateResponseFieldValueType = "NUMBER"

const ContactCreateResponseFieldValueTypeSingleSelect ContactCreateResponseFieldValueType = "SINGLE_SELECT"

const ContactCreateResponseFieldValueTypeSocialHandle ContactCreateResponseFieldValueType = "SOCIAL_HANDLE"

const ContactCreateResponseFieldValueTypeTelephone ContactCreateResponseFieldValueType = "TELEPHONE"

const ContactCreateResponseFieldValueTypeText ContactCreateResponseFieldValueType = "TEXT"

const ContactCreateResponseFieldValueTypeURL ContactCreateResponseFieldValueType = "URL"

const ContactCreateResponseFieldValueTypeHTML ContactCreateResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

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.

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ContactCreateResponseRelationshipDirectionsOptional

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 ContactCreateResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactCreateResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type ContactDefinitionsResponse struct{…}

FieldDefinitions map[string, ContactDefinitionsResponseFieldDefinition]

Map of field keys to their definitions, including both system and custom fields.

Description string

Description of the field, or null.

Label string

Human-readable display name of the field.

TypeConfiguration ContactDefinitionsResponseFieldDefinitionTypeConfiguration

Type-specific configuration (e.g. select options, currency code).

Currency stringOptional

ISO 4217 3-letter currency code.

HandleService stringOptional

Social platform associated with this handle field.

One of the following:

const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"

const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"

const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"

const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"

MultipleValues boolOptional

Whether this field accepts multiple values.

Options []ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options for select fields.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Description stringOptional

Description of the option, or null.

ParentID stringOptional

For a dependent select, the ID of the option in the parent field named by typeConfiguration.parentFieldKey that owns this option. Absent for ordinary selects.

ParentFieldKey stringOptional

For a dependent select, the field key whose selected option determines which of this field’s options apply. Absent for ordinary selects.

Unique boolOptional

Whether values for this field must be unique.

ValueType string

Data type of the field.

One of the following:

const ContactDefinitionsResponseFieldDefinitionValueTypeAddress ContactDefinitionsResponseFieldDefinitionValueType = "ADDRESS"

const ContactDefinitionsResponseFieldDefinitionValueTypeCheckbox ContactDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"

const ContactDefinitionsResponseFieldDefinitionValueTypeCurrency ContactDefinitionsResponseFieldDefinitionValueType = "CURRENCY"

const ContactDefinitionsResponseFieldDefinitionValueTypeDatetime ContactDefinitionsResponseFieldDefinitionValueType = "DATETIME"

const ContactDefinitionsResponseFieldDefinitionValueTypeEmail ContactDefinitionsResponseFieldDefinitionValueType = "EMAIL"

const ContactDefinitionsResponseFieldDefinitionValueTypeFullName ContactDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"

const ContactDefinitionsResponseFieldDefinitionValueTypeMarkdown ContactDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"

const ContactDefinitionsResponseFieldDefinitionValueTypeMultiSelect ContactDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"

const ContactDefinitionsResponseFieldDefinitionValueTypeNumber ContactDefinitionsResponseFieldDefinitionValueType = "NUMBER"

const ContactDefinitionsResponseFieldDefinitionValueTypeSingleSelect ContactDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"

const ContactDefinitionsResponseFieldDefinitionValueTypeSocialHandle ContactDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"

const ContactDefinitionsResponseFieldDefinitionValueTypeTelephone ContactDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"

const ContactDefinitionsResponseFieldDefinitionValueTypeText ContactDefinitionsResponseFieldDefinitionValueType = "TEXT"

const ContactDefinitionsResponseFieldDefinitionValueTypeURL ContactDefinitionsResponseFieldDefinitionValueType = "URL"

const ContactDefinitionsResponseFieldDefinitionValueTypeHTML ContactDefinitionsResponseFieldDefinitionValueType = "HTML"

ID stringOptional

Unique identifier of the field definition.

ReadOnly boolOptional

true for fields that are not writable via the API (e.g. AI-generated summaries). false or absent for writable fields.

ObjectType string

The object type these definitions belong to (e.g. account).

RelationshipDefinitions map[string, ContactDefinitionsResponseRelationshipDefinition]

Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.

Cardinality string

Whether this is a has_one or has_many relationship.

One of the following:

const ContactDefinitionsResponseRelationshipDefinitionCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"

const ContactDefinitionsResponseRelationshipDefinitionCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"

Description string

Description of the relationship, or null.

Label string

Human-readable display name of the relationship.

ObjectType string

The type of the related object (e.g. account, contact).

ID stringOptional

Unique identifier of the relationship definition.

Directions ContactDefinitionsResponseRelationshipDefinitionDirectionsOptional

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 ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"

Label string

Human-readable display name for this endpoint direction.

AsSource ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"

const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_MANY"

Label string

Human-readable display name for this endpoint direction.

type ContactDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

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.

Value ContactDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactDeleteResponseFieldValueArray []string

type ContactDeleteResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactDeleteResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactDeleteResponseFieldValueTypeAddress ContactDeleteResponseFieldValueType = "ADDRESS"

const ContactDeleteResponseFieldValueTypeCheckbox ContactDeleteResponseFieldValueType = "CHECKBOX"

const ContactDeleteResponseFieldValueTypeCurrency ContactDeleteResponseFieldValueType = "CURRENCY"

const ContactDeleteResponseFieldValueTypeDatetime ContactDeleteResponseFieldValueType = "DATETIME"

const ContactDeleteResponseFieldValueTypeEmail ContactDeleteResponseFieldValueType = "EMAIL"

const ContactDeleteResponseFieldValueTypeFullName ContactDeleteResponseFieldValueType = "FULL_NAME"

const ContactDeleteResponseFieldValueTypeMarkdown ContactDeleteResponseFieldValueType = "MARKDOWN"

const ContactDeleteResponseFieldValueTypeMultiSelect ContactDeleteResponseFieldValueType = "MULTI_SELECT"

const ContactDeleteResponseFieldValueTypeNumber ContactDeleteResponseFieldValueType = "NUMBER"

const ContactDeleteResponseFieldValueTypeSingleSelect ContactDeleteResponseFieldValueType = "SINGLE_SELECT"

const ContactDeleteResponseFieldValueTypeSocialHandle ContactDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const ContactDeleteResponseFieldValueTypeTelephone ContactDeleteResponseFieldValueType = "TELEPHONE"

const ContactDeleteResponseFieldValueTypeText ContactDeleteResponseFieldValueType = "TEXT"

const ContactDeleteResponseFieldValueTypeURL ContactDeleteResponseFieldValueType = "URL"

const ContactDeleteResponseFieldValueTypeHTML ContactDeleteResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, ContactDeleteResponseRelationship]

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ContactDeleteResponseRelationshipDirectionsOptional

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 ContactDeleteResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactDeleteResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type ContactFieldHistoryResponse struct{…}

Data []ContactFieldHistoryResponseData

Recorded values for the field, newest first.

DisplayValue string

Human-readable rendering of the value (e.g. a select option label), suitable for display.

IsCreate bool

True for the record’s original value. Only set when the full history fits in the response (never on a truncated/paginated page).

RecordedAt string

ISO 8601 timestamp of when this value was recorded.

Value ContactFieldHistoryResponseDataValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactFieldHistoryResponseDataValueArray []string

type ContactFieldHistoryResponseDataValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactFieldHistoryResponseDataValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactFieldHistoryResponseDataValueTypeAddress ContactFieldHistoryResponseDataValueType = "ADDRESS"

const ContactFieldHistoryResponseDataValueTypeCheckbox ContactFieldHistoryResponseDataValueType = "CHECKBOX"

const ContactFieldHistoryResponseDataValueTypeCurrency ContactFieldHistoryResponseDataValueType = "CURRENCY"

const ContactFieldHistoryResponseDataValueTypeDatetime ContactFieldHistoryResponseDataValueType = "DATETIME"

const ContactFieldHistoryResponseDataValueTypeEmail ContactFieldHistoryResponseDataValueType = "EMAIL"

const ContactFieldHistoryResponseDataValueTypeFullName ContactFieldHistoryResponseDataValueType = "FULL_NAME"

const ContactFieldHistoryResponseDataValueTypeMarkdown ContactFieldHistoryResponseDataValueType = "MARKDOWN"

const ContactFieldHistoryResponseDataValueTypeMultiSelect ContactFieldHistoryResponseDataValueType = "MULTI_SELECT"

const ContactFieldHistoryResponseDataValueTypeNumber ContactFieldHistoryResponseDataValueType = "NUMBER"

const ContactFieldHistoryResponseDataValueTypeSingleSelect ContactFieldHistoryResponseDataValueType = "SINGLE_SELECT"

const ContactFieldHistoryResponseDataValueTypeSocialHandle ContactFieldHistoryResponseDataValueType = "SOCIAL_HANDLE"

const ContactFieldHistoryResponseDataValueTypeTelephone ContactFieldHistoryResponseDataValueType = "TELEPHONE"

const ContactFieldHistoryResponseDataValueTypeText ContactFieldHistoryResponseDataValueType = "TEXT"

const ContactFieldHistoryResponseDataValueTypeURL ContactFieldHistoryResponseDataValueType = "URL"

const ContactFieldHistoryResponseDataValueTypeHTML ContactFieldHistoryResponseDataValueType = "HTML"

HasMore bool

Whether more history exists beyond this page.

NextCursor string

Cursor to pass as after to fetch the next page, or null when there are no more entries.

type ContactListResponse struct{…}

Data []ContactListResponseData

Array of entity objects for the current page.

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

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.

Value ContactListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactListResponseDataFieldValueArray []string

type ContactListResponseDataFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactListResponseDataFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactListResponseDataFieldValueTypeAddress ContactListResponseDataFieldValueType = "ADDRESS"

const ContactListResponseDataFieldValueTypeCheckbox ContactListResponseDataFieldValueType = "CHECKBOX"

const ContactListResponseDataFieldValueTypeCurrency ContactListResponseDataFieldValueType = "CURRENCY"

const ContactListResponseDataFieldValueTypeDatetime ContactListResponseDataFieldValueType = "DATETIME"

const ContactListResponseDataFieldValueTypeEmail ContactListResponseDataFieldValueType = "EMAIL"

const ContactListResponseDataFieldValueTypeFullName ContactListResponseDataFieldValueType = "FULL_NAME"

const ContactListResponseDataFieldValueTypeMarkdown ContactListResponseDataFieldValueType = "MARKDOWN"

const ContactListResponseDataFieldValueTypeMultiSelect ContactListResponseDataFieldValueType = "MULTI_SELECT"

const ContactListResponseDataFieldValueTypeNumber ContactListResponseDataFieldValueType = "NUMBER"

const ContactListResponseDataFieldValueTypeSingleSelect ContactListResponseDataFieldValueType = "SINGLE_SELECT"

const ContactListResponseDataFieldValueTypeSocialHandle ContactListResponseDataFieldValueType = "SOCIAL_HANDLE"

const ContactListResponseDataFieldValueTypeTelephone ContactListResponseDataFieldValueType = "TELEPHONE"

const ContactListResponseDataFieldValueTypeText ContactListResponseDataFieldValueType = "TEXT"

const ContactListResponseDataFieldValueTypeURL ContactListResponseDataFieldValueType = "URL"

const ContactListResponseDataFieldValueTypeHTML ContactListResponseDataFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, ContactListResponseDataRelationship]

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ContactListResponseDataRelationshipDirectionsOptional

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 ContactListResponseDataRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne ContactListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany ContactListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactListResponseDataRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne ContactListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany ContactListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0

maximum9007199254740991

type ContactRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

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.

Value ContactRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactRestoreResponseFieldValueArray []string

type ContactRestoreResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactRestoreResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactRestoreResponseFieldValueTypeAddress ContactRestoreResponseFieldValueType = "ADDRESS"

const ContactRestoreResponseFieldValueTypeCheckbox ContactRestoreResponseFieldValueType = "CHECKBOX"

const ContactRestoreResponseFieldValueTypeCurrency ContactRestoreResponseFieldValueType = "CURRENCY"

const ContactRestoreResponseFieldValueTypeDatetime ContactRestoreResponseFieldValueType = "DATETIME"

const ContactRestoreResponseFieldValueTypeEmail ContactRestoreResponseFieldValueType = "EMAIL"

const ContactRestoreResponseFieldValueTypeFullName ContactRestoreResponseFieldValueType = "FULL_NAME"

const ContactRestoreResponseFieldValueTypeMarkdown ContactRestoreResponseFieldValueType = "MARKDOWN"

const ContactRestoreResponseFieldValueTypeMultiSelect ContactRestoreResponseFieldValueType = "MULTI_SELECT"

const ContactRestoreResponseFieldValueTypeNumber ContactRestoreResponseFieldValueType = "NUMBER"

const ContactRestoreResponseFieldValueTypeSingleSelect ContactRestoreResponseFieldValueType = "SINGLE_SELECT"

const ContactRestoreResponseFieldValueTypeSocialHandle ContactRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const ContactRestoreResponseFieldValueTypeTelephone ContactRestoreResponseFieldValueType = "TELEPHONE"

const ContactRestoreResponseFieldValueTypeText ContactRestoreResponseFieldValueType = "TEXT"

const ContactRestoreResponseFieldValueTypeURL ContactRestoreResponseFieldValueType = "URL"

const ContactRestoreResponseFieldValueTypeHTML ContactRestoreResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, ContactRestoreResponseRelationship]

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ContactRestoreResponseRelationshipDirectionsOptional

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 ContactRestoreResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactRestoreResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type ContactRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactRetrieveResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value ContactRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactRetrieveResponseFieldValueArray []string

type ContactRetrieveResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactRetrieveResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactRetrieveResponseFieldValueTypeAddress ContactRetrieveResponseFieldValueType = "ADDRESS"

const ContactRetrieveResponseFieldValueTypeCheckbox ContactRetrieveResponseFieldValueType = "CHECKBOX"

const ContactRetrieveResponseFieldValueTypeCurrency ContactRetrieveResponseFieldValueType = "CURRENCY"

const ContactRetrieveResponseFieldValueTypeDatetime ContactRetrieveResponseFieldValueType = "DATETIME"

const ContactRetrieveResponseFieldValueTypeEmail ContactRetrieveResponseFieldValueType = "EMAIL"

const ContactRetrieveResponseFieldValueTypeFullName ContactRetrieveResponseFieldValueType = "FULL_NAME"

const ContactRetrieveResponseFieldValueTypeMarkdown ContactRetrieveResponseFieldValueType = "MARKDOWN"

const ContactRetrieveResponseFieldValueTypeMultiSelect ContactRetrieveResponseFieldValueType = "MULTI_SELECT"

const ContactRetrieveResponseFieldValueTypeNumber ContactRetrieveResponseFieldValueType = "NUMBER"

const ContactRetrieveResponseFieldValueTypeSingleSelect ContactRetrieveResponseFieldValueType = "SINGLE_SELECT"

const ContactRetrieveResponseFieldValueTypeSocialHandle ContactRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const ContactRetrieveResponseFieldValueTypeTelephone ContactRetrieveResponseFieldValueType = "TELEPHONE"

const ContactRetrieveResponseFieldValueTypeText ContactRetrieveResponseFieldValueType = "TEXT"

const ContactRetrieveResponseFieldValueTypeURL ContactRetrieveResponseFieldValueType = "URL"

const ContactRetrieveResponseFieldValueTypeHTML ContactRetrieveResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, ContactRetrieveResponseRelationship]

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ContactRetrieveResponseRelationshipDirectionsOptional

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 ContactRetrieveResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactRetrieveResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type ContactUpdateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

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.

Value ContactUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactUpdateResponseFieldValueArray []string

type ContactUpdateResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactUpdateResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactUpdateResponseFieldValueTypeAddress ContactUpdateResponseFieldValueType = "ADDRESS"

const ContactUpdateResponseFieldValueTypeCheckbox ContactUpdateResponseFieldValueType = "CHECKBOX"

const ContactUpdateResponseFieldValueTypeCurrency ContactUpdateResponseFieldValueType = "CURRENCY"

const ContactUpdateResponseFieldValueTypeDatetime ContactUpdateResponseFieldValueType = "DATETIME"

const ContactUpdateResponseFieldValueTypeEmail ContactUpdateResponseFieldValueType = "EMAIL"

const ContactUpdateResponseFieldValueTypeFullName ContactUpdateResponseFieldValueType = "FULL_NAME"

const ContactUpdateResponseFieldValueTypeMarkdown ContactUpdateResponseFieldValueType = "MARKDOWN"

const ContactUpdateResponseFieldValueTypeMultiSelect ContactUpdateResponseFieldValueType = "MULTI_SELECT"

const ContactUpdateResponseFieldValueTypeNumber ContactUpdateResponseFieldValueType = "NUMBER"

const ContactUpdateResponseFieldValueTypeSingleSelect ContactUpdateResponseFieldValueType = "SINGLE_SELECT"

const ContactUpdateResponseFieldValueTypeSocialHandle ContactUpdateResponseFieldValueType = "SOCIAL_HANDLE"

const ContactUpdateResponseFieldValueTypeTelephone ContactUpdateResponseFieldValueType = "TELEPHONE"

const ContactUpdateResponseFieldValueTypeText ContactUpdateResponseFieldValueType = "TEXT"

const ContactUpdateResponseFieldValueTypeURL ContactUpdateResponseFieldValueType = "URL"

const ContactUpdateResponseFieldValueTypeHTML ContactUpdateResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, ContactUpdateResponseRelationship]

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ContactUpdateResponseRelationshipDirectionsOptional

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 ContactUpdateResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactUpdateResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

const ContactUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.