Account

Accounts represent companies or organizations in Lightfield. Each account can have contacts, opportunities, tasks, and notes associated with it.

Get account field definitions

client.Account.Definitions(ctx) (*AccountDefinitionsResponse, error)

GET/v1/accounts/definitions

Get field value history

client.Account.FieldHistory(ctx, fieldKey, params) (*AccountFieldHistoryResponse, error)

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

Create an account

client.Account.New(ctx, body) (*AccountCreateResponse, error)

POST/v1/accounts

Update an account

client.Account.Update(ctx, id, body) (*AccountUpdateResponse, error)

POST/v1/accounts/{id}

Retrieve an account

client.Account.Get(ctx, id) (*AccountRetrieveResponse, error)

GET/v1/accounts/{id}

List accounts

client.Account.List(ctx, query) (*AccountListResponse, error)

GET/v1/accounts

Delete an account

client.Account.Delete(ctx, id, body) (*AccountDeleteResponse, error)

DELETE/v1/accounts/{id}

Restore an account

client.Account.Restore(ctx, id, body) (*AccountRestoreResponse, error)

POST/v1/accounts/{id}/restore

ModelsExpand Collapse

type AccountCreateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountCreateResponseField]

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

Value AccountCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountCreateResponseFieldValueArray []string

type AccountCreateResponseFieldValueAddress 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 AccountCreateResponseFieldValueFullName 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 AccountCreateResponseFieldValueTypeAddress AccountCreateResponseFieldValueType = "ADDRESS"

const AccountCreateResponseFieldValueTypeCheckbox AccountCreateResponseFieldValueType = "CHECKBOX"

const AccountCreateResponseFieldValueTypeCurrency AccountCreateResponseFieldValueType = "CURRENCY"

const AccountCreateResponseFieldValueTypeDatetime AccountCreateResponseFieldValueType = "DATETIME"

const AccountCreateResponseFieldValueTypeEmail AccountCreateResponseFieldValueType = "EMAIL"

const AccountCreateResponseFieldValueTypeFullName AccountCreateResponseFieldValueType = "FULL_NAME"

const AccountCreateResponseFieldValueTypeMarkdown AccountCreateResponseFieldValueType = "MARKDOWN"

const AccountCreateResponseFieldValueTypeMultiSelect AccountCreateResponseFieldValueType = "MULTI_SELECT"

const AccountCreateResponseFieldValueTypeNumber AccountCreateResponseFieldValueType = "NUMBER"

const AccountCreateResponseFieldValueTypeSingleSelect AccountCreateResponseFieldValueType = "SINGLE_SELECT"

const AccountCreateResponseFieldValueTypeSocialHandle AccountCreateResponseFieldValueType = "SOCIAL_HANDLE"

const AccountCreateResponseFieldValueTypeTelephone AccountCreateResponseFieldValueType = "TELEPHONE"

const AccountCreateResponseFieldValueTypeText AccountCreateResponseFieldValueType = "TEXT"

const AccountCreateResponseFieldValueTypeURL AccountCreateResponseFieldValueType = "URL"

const AccountCreateResponseFieldValueTypeHTML AccountCreateResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountCreateResponseRelationship]

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 AccountCreateResponseRelationshipDirectionsOptional

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 AccountCreateResponseRelationshipDirectionsAsDestination

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 AccountCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne AccountCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany AccountCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource AccountCreateResponseRelationshipDirectionsAsSource

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 AccountCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne AccountCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const AccountCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany AccountCreateResponseRelationshipDirectionsAsSourceCardinality = "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 AccountDefinitionsResponse struct{…}

FieldDefinitions map[string, AccountDefinitionsResponseFieldDefinition]

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 AccountDefinitionsResponseFieldDefinitionTypeConfiguration

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 AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"

const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"

const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"

const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"

MultipleValues boolOptional

Whether this field accepts multiple values.

Options []AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

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 AccountDefinitionsResponseFieldDefinitionValueTypeAddress AccountDefinitionsResponseFieldDefinitionValueType = "ADDRESS"

const AccountDefinitionsResponseFieldDefinitionValueTypeCheckbox AccountDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"

const AccountDefinitionsResponseFieldDefinitionValueTypeCurrency AccountDefinitionsResponseFieldDefinitionValueType = "CURRENCY"

const AccountDefinitionsResponseFieldDefinitionValueTypeDatetime AccountDefinitionsResponseFieldDefinitionValueType = "DATETIME"

const AccountDefinitionsResponseFieldDefinitionValueTypeEmail AccountDefinitionsResponseFieldDefinitionValueType = "EMAIL"

const AccountDefinitionsResponseFieldDefinitionValueTypeFullName AccountDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"

const AccountDefinitionsResponseFieldDefinitionValueTypeMarkdown AccountDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"

const AccountDefinitionsResponseFieldDefinitionValueTypeMultiSelect AccountDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"

const AccountDefinitionsResponseFieldDefinitionValueTypeNumber AccountDefinitionsResponseFieldDefinitionValueType = "NUMBER"

const AccountDefinitionsResponseFieldDefinitionValueTypeSingleSelect AccountDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"

const AccountDefinitionsResponseFieldDefinitionValueTypeSocialHandle AccountDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"

const AccountDefinitionsResponseFieldDefinitionValueTypeTelephone AccountDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"

const AccountDefinitionsResponseFieldDefinitionValueTypeText AccountDefinitionsResponseFieldDefinitionValueType = "TEXT"

const AccountDefinitionsResponseFieldDefinitionValueTypeURL AccountDefinitionsResponseFieldDefinitionValueType = "URL"

const AccountDefinitionsResponseFieldDefinitionValueTypeHTML AccountDefinitionsResponseFieldDefinitionValueType = "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, AccountDefinitionsResponseRelationshipDefinition]

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 AccountDefinitionsResponseRelationshipDefinitionCardinalityHasOne AccountDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"

const AccountDefinitionsResponseRelationshipDefinitionCardinalityHasMany AccountDefinitionsResponseRelationshipDefinitionCardinality = "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 AccountDefinitionsResponseRelationshipDefinitionDirectionsOptional

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 AccountDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

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 AccountDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne AccountDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany AccountDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"

Label string

Human-readable display name for this endpoint direction.

AsSource AccountDefinitionsResponseRelationshipDefinitionDirectionsAsSource

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 AccountDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne AccountDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"

const AccountDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany AccountDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_MANY"

Label string

Human-readable display name for this endpoint direction.

type AccountDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountDeleteResponseField]

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

Value AccountDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountDeleteResponseFieldValueArray []string

type AccountDeleteResponseFieldValueAddress 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 AccountDeleteResponseFieldValueFullName 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 AccountDeleteResponseFieldValueTypeAddress AccountDeleteResponseFieldValueType = "ADDRESS"

const AccountDeleteResponseFieldValueTypeCheckbox AccountDeleteResponseFieldValueType = "CHECKBOX"

const AccountDeleteResponseFieldValueTypeCurrency AccountDeleteResponseFieldValueType = "CURRENCY"

const AccountDeleteResponseFieldValueTypeDatetime AccountDeleteResponseFieldValueType = "DATETIME"

const AccountDeleteResponseFieldValueTypeEmail AccountDeleteResponseFieldValueType = "EMAIL"

const AccountDeleteResponseFieldValueTypeFullName AccountDeleteResponseFieldValueType = "FULL_NAME"

const AccountDeleteResponseFieldValueTypeMarkdown AccountDeleteResponseFieldValueType = "MARKDOWN"

const AccountDeleteResponseFieldValueTypeMultiSelect AccountDeleteResponseFieldValueType = "MULTI_SELECT"

const AccountDeleteResponseFieldValueTypeNumber AccountDeleteResponseFieldValueType = "NUMBER"

const AccountDeleteResponseFieldValueTypeSingleSelect AccountDeleteResponseFieldValueType = "SINGLE_SELECT"

const AccountDeleteResponseFieldValueTypeSocialHandle AccountDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const AccountDeleteResponseFieldValueTypeTelephone AccountDeleteResponseFieldValueType = "TELEPHONE"

const AccountDeleteResponseFieldValueTypeText AccountDeleteResponseFieldValueType = "TEXT"

const AccountDeleteResponseFieldValueTypeURL AccountDeleteResponseFieldValueType = "URL"

const AccountDeleteResponseFieldValueTypeHTML AccountDeleteResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountDeleteResponseRelationship]

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 AccountDeleteResponseRelationshipDirectionsOptional

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 AccountDeleteResponseRelationshipDirectionsAsDestination

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 AccountDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne AccountDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany AccountDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource AccountDeleteResponseRelationshipDirectionsAsSource

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 AccountDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne AccountDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const AccountDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany AccountDeleteResponseRelationshipDirectionsAsSourceCardinality = "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 AccountFieldHistoryResponse struct{…}

Data []AccountFieldHistoryResponseData

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 AccountFieldHistoryResponseDataValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountFieldHistoryResponseDataValueArray []string

type AccountFieldHistoryResponseDataValueAddress 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 AccountFieldHistoryResponseDataValueFullName 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 AccountFieldHistoryResponseDataValueTypeAddress AccountFieldHistoryResponseDataValueType = "ADDRESS"

const AccountFieldHistoryResponseDataValueTypeCheckbox AccountFieldHistoryResponseDataValueType = "CHECKBOX"

const AccountFieldHistoryResponseDataValueTypeCurrency AccountFieldHistoryResponseDataValueType = "CURRENCY"

const AccountFieldHistoryResponseDataValueTypeDatetime AccountFieldHistoryResponseDataValueType = "DATETIME"

const AccountFieldHistoryResponseDataValueTypeEmail AccountFieldHistoryResponseDataValueType = "EMAIL"

const AccountFieldHistoryResponseDataValueTypeFullName AccountFieldHistoryResponseDataValueType = "FULL_NAME"

const AccountFieldHistoryResponseDataValueTypeMarkdown AccountFieldHistoryResponseDataValueType = "MARKDOWN"

const AccountFieldHistoryResponseDataValueTypeMultiSelect AccountFieldHistoryResponseDataValueType = "MULTI_SELECT"

const AccountFieldHistoryResponseDataValueTypeNumber AccountFieldHistoryResponseDataValueType = "NUMBER"

const AccountFieldHistoryResponseDataValueTypeSingleSelect AccountFieldHistoryResponseDataValueType = "SINGLE_SELECT"

const AccountFieldHistoryResponseDataValueTypeSocialHandle AccountFieldHistoryResponseDataValueType = "SOCIAL_HANDLE"

const AccountFieldHistoryResponseDataValueTypeTelephone AccountFieldHistoryResponseDataValueType = "TELEPHONE"

const AccountFieldHistoryResponseDataValueTypeText AccountFieldHistoryResponseDataValueType = "TEXT"

const AccountFieldHistoryResponseDataValueTypeURL AccountFieldHistoryResponseDataValueType = "URL"

const AccountFieldHistoryResponseDataValueTypeHTML AccountFieldHistoryResponseDataValueType = "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 AccountListResponse struct{…}

Data []AccountListResponseData

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, AccountListResponseDataField]

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

Value AccountListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountListResponseDataFieldValueArray []string

type AccountListResponseDataFieldValueAddress 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 AccountListResponseDataFieldValueFullName 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 AccountListResponseDataFieldValueTypeAddress AccountListResponseDataFieldValueType = "ADDRESS"

const AccountListResponseDataFieldValueTypeCheckbox AccountListResponseDataFieldValueType = "CHECKBOX"

const AccountListResponseDataFieldValueTypeCurrency AccountListResponseDataFieldValueType = "CURRENCY"

const AccountListResponseDataFieldValueTypeDatetime AccountListResponseDataFieldValueType = "DATETIME"

const AccountListResponseDataFieldValueTypeEmail AccountListResponseDataFieldValueType = "EMAIL"

const AccountListResponseDataFieldValueTypeFullName AccountListResponseDataFieldValueType = "FULL_NAME"

const AccountListResponseDataFieldValueTypeMarkdown AccountListResponseDataFieldValueType = "MARKDOWN"

const AccountListResponseDataFieldValueTypeMultiSelect AccountListResponseDataFieldValueType = "MULTI_SELECT"

const AccountListResponseDataFieldValueTypeNumber AccountListResponseDataFieldValueType = "NUMBER"

const AccountListResponseDataFieldValueTypeSingleSelect AccountListResponseDataFieldValueType = "SINGLE_SELECT"

const AccountListResponseDataFieldValueTypeSocialHandle AccountListResponseDataFieldValueType = "SOCIAL_HANDLE"

const AccountListResponseDataFieldValueTypeTelephone AccountListResponseDataFieldValueType = "TELEPHONE"

const AccountListResponseDataFieldValueTypeText AccountListResponseDataFieldValueType = "TEXT"

const AccountListResponseDataFieldValueTypeURL AccountListResponseDataFieldValueType = "URL"

const AccountListResponseDataFieldValueTypeHTML AccountListResponseDataFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountListResponseDataRelationship]

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 AccountListResponseDataRelationshipDirectionsOptional

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 AccountListResponseDataRelationshipDirectionsAsDestination

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 AccountListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne AccountListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany AccountListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource AccountListResponseDataRelationshipDirectionsAsSource

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 AccountListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne AccountListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const AccountListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany AccountListResponseDataRelationshipDirectionsAsSourceCardinality = "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 AccountRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountRestoreResponseField]

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

Value AccountRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountRestoreResponseFieldValueArray []string

type AccountRestoreResponseFieldValueAddress 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 AccountRestoreResponseFieldValueFullName 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 AccountRestoreResponseFieldValueTypeAddress AccountRestoreResponseFieldValueType = "ADDRESS"

const AccountRestoreResponseFieldValueTypeCheckbox AccountRestoreResponseFieldValueType = "CHECKBOX"

const AccountRestoreResponseFieldValueTypeCurrency AccountRestoreResponseFieldValueType = "CURRENCY"

const AccountRestoreResponseFieldValueTypeDatetime AccountRestoreResponseFieldValueType = "DATETIME"

const AccountRestoreResponseFieldValueTypeEmail AccountRestoreResponseFieldValueType = "EMAIL"

const AccountRestoreResponseFieldValueTypeFullName AccountRestoreResponseFieldValueType = "FULL_NAME"

const AccountRestoreResponseFieldValueTypeMarkdown AccountRestoreResponseFieldValueType = "MARKDOWN"

const AccountRestoreResponseFieldValueTypeMultiSelect AccountRestoreResponseFieldValueType = "MULTI_SELECT"

const AccountRestoreResponseFieldValueTypeNumber AccountRestoreResponseFieldValueType = "NUMBER"

const AccountRestoreResponseFieldValueTypeSingleSelect AccountRestoreResponseFieldValueType = "SINGLE_SELECT"

const AccountRestoreResponseFieldValueTypeSocialHandle AccountRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const AccountRestoreResponseFieldValueTypeTelephone AccountRestoreResponseFieldValueType = "TELEPHONE"

const AccountRestoreResponseFieldValueTypeText AccountRestoreResponseFieldValueType = "TEXT"

const AccountRestoreResponseFieldValueTypeURL AccountRestoreResponseFieldValueType = "URL"

const AccountRestoreResponseFieldValueTypeHTML AccountRestoreResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountRestoreResponseRelationship]

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 AccountRestoreResponseRelationshipDirectionsOptional

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 AccountRestoreResponseRelationshipDirectionsAsDestination

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 AccountRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne AccountRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany AccountRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource AccountRestoreResponseRelationshipDirectionsAsSource

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 AccountRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne AccountRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const AccountRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany AccountRestoreResponseRelationshipDirectionsAsSourceCardinality = "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 AccountRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountRetrieveResponseField]

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

Value AccountRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountRetrieveResponseFieldValueArray []string

type AccountRetrieveResponseFieldValueAddress 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 AccountRetrieveResponseFieldValueFullName 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 AccountRetrieveResponseFieldValueTypeAddress AccountRetrieveResponseFieldValueType = "ADDRESS"

const AccountRetrieveResponseFieldValueTypeCheckbox AccountRetrieveResponseFieldValueType = "CHECKBOX"

const AccountRetrieveResponseFieldValueTypeCurrency AccountRetrieveResponseFieldValueType = "CURRENCY"

const AccountRetrieveResponseFieldValueTypeDatetime AccountRetrieveResponseFieldValueType = "DATETIME"

const AccountRetrieveResponseFieldValueTypeEmail AccountRetrieveResponseFieldValueType = "EMAIL"

const AccountRetrieveResponseFieldValueTypeFullName AccountRetrieveResponseFieldValueType = "FULL_NAME"

const AccountRetrieveResponseFieldValueTypeMarkdown AccountRetrieveResponseFieldValueType = "MARKDOWN"

const AccountRetrieveResponseFieldValueTypeMultiSelect AccountRetrieveResponseFieldValueType = "MULTI_SELECT"

const AccountRetrieveResponseFieldValueTypeNumber AccountRetrieveResponseFieldValueType = "NUMBER"

const AccountRetrieveResponseFieldValueTypeSingleSelect AccountRetrieveResponseFieldValueType = "SINGLE_SELECT"

const AccountRetrieveResponseFieldValueTypeSocialHandle AccountRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const AccountRetrieveResponseFieldValueTypeTelephone AccountRetrieveResponseFieldValueType = "TELEPHONE"

const AccountRetrieveResponseFieldValueTypeText AccountRetrieveResponseFieldValueType = "TEXT"

const AccountRetrieveResponseFieldValueTypeURL AccountRetrieveResponseFieldValueType = "URL"

const AccountRetrieveResponseFieldValueTypeHTML AccountRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountRetrieveResponseRelationship]

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 AccountRetrieveResponseRelationshipDirectionsOptional

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 AccountRetrieveResponseRelationshipDirectionsAsDestination

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 AccountRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne AccountRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany AccountRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource AccountRetrieveResponseRelationshipDirectionsAsSource

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 AccountRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne AccountRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const AccountRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany AccountRetrieveResponseRelationshipDirectionsAsSourceCardinality = "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 AccountUpdateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountUpdateResponseField]

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

Value AccountUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountUpdateResponseFieldValueArray []string

type AccountUpdateResponseFieldValueAddress 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 AccountUpdateResponseFieldValueFullName 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 AccountUpdateResponseFieldValueTypeAddress AccountUpdateResponseFieldValueType = "ADDRESS"

const AccountUpdateResponseFieldValueTypeCheckbox AccountUpdateResponseFieldValueType = "CHECKBOX"

const AccountUpdateResponseFieldValueTypeCurrency AccountUpdateResponseFieldValueType = "CURRENCY"

const AccountUpdateResponseFieldValueTypeDatetime AccountUpdateResponseFieldValueType = "DATETIME"

const AccountUpdateResponseFieldValueTypeEmail AccountUpdateResponseFieldValueType = "EMAIL"

const AccountUpdateResponseFieldValueTypeFullName AccountUpdateResponseFieldValueType = "FULL_NAME"

const AccountUpdateResponseFieldValueTypeMarkdown AccountUpdateResponseFieldValueType = "MARKDOWN"

const AccountUpdateResponseFieldValueTypeMultiSelect AccountUpdateResponseFieldValueType = "MULTI_SELECT"

const AccountUpdateResponseFieldValueTypeNumber AccountUpdateResponseFieldValueType = "NUMBER"

const AccountUpdateResponseFieldValueTypeSingleSelect AccountUpdateResponseFieldValueType = "SINGLE_SELECT"

const AccountUpdateResponseFieldValueTypeSocialHandle AccountUpdateResponseFieldValueType = "SOCIAL_HANDLE"

const AccountUpdateResponseFieldValueTypeTelephone AccountUpdateResponseFieldValueType = "TELEPHONE"

const AccountUpdateResponseFieldValueTypeText AccountUpdateResponseFieldValueType = "TEXT"

const AccountUpdateResponseFieldValueTypeURL AccountUpdateResponseFieldValueType = "URL"

const AccountUpdateResponseFieldValueTypeHTML AccountUpdateResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountUpdateResponseRelationship]

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 AccountUpdateResponseRelationshipDirectionsOptional

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 AccountUpdateResponseRelationshipDirectionsAsDestination

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 AccountUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne AccountUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const AccountUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany AccountUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource AccountUpdateResponseRelationshipDirectionsAsSource

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 AccountUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne AccountUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const AccountUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany AccountUpdateResponseRelationshipDirectionsAsSourceCardinality = "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.