Skip to content

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, query) (*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) (*AccountRetrieveResponseUnion, 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 AccountCreateResponseFieldValueTypeDate AccountCreateResponseFieldValueType = "DATE"
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"
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.

Archived bool

Whether the field definition is archived.

ArchivedAt Time

When the field definition was archived, or null if active.

formatdate-time
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). A key the field type does not support is absent; a supported key with nothing set is null.

Currency stringOptional

ISO 4217 3-letter currency code. Present on CURRENCY fields, absent on every other type.

DecimalPlaces int64Optional

Number of decimal places values carry, or null when none is set. Present on NUMBER and CURRENCY fields, absent on every other type.

minimum-9007199254740991
maximum9007199254740991
HandleService stringOptional

Social platform associated with this handle field, or null when none is set. Present on SOCIAL_HANDLE fields, absent on every other type.

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. Present on EMAIL, TELEPHONE and URL fields, absent on every other type.

Options []AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options. Always present on SINGLE_SELECT and MULTI_SELECT fields, as an empty list when there are none. Absent on every other type.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Category stringOptional

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.

One of the following:
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryActive AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "ACTIVE"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryCompleted AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "COMPLETED"
Color stringOptional

Color the option is displayed in, GRAY when none was chosen. Absent on selects whose options take no color.

One of the following:
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorRed AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "RED"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorOrange AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "ORANGE"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorYellow AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "YELLOW"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorLime AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "LIME"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGreen AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GREEN"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorBlue AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "BLUE"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorIndigo AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "INDIGO"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorPurple AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "PURPLE"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorCopper AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "COPPER"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGray AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GRAY"
Description stringOptional

Description of the option, or null.

ForecastPercentage float64Optional

Forecast weighting of the option from 0 to 100, or null when none is set. Absent on selects whose options take no forecast.

Icon stringOptional

Icon the option is displayed with, or null when none is set. Present only on $stage.

One of the following:
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconBacklog AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "BACKLOG"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconQualification AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "QUALIFICATION"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconDiscovery AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "DISCOVERY"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconActive AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "ACTIVE"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconNegotiation AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "NEGOTIATION"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedWon AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_WON"
const AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedLost AccountDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_LOST"
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, or null when not set. Present on EMAIL, TELEPHONE, URL and SOCIAL_HANDLE fields, absent on every other type.

ValueType string

Data type of the field.

One of the following:
const AccountDefinitionsResponseFieldDefinitionValueTypeAddress AccountDefinitionsResponseFieldDefinitionValueType = "ADDRESS"
const AccountDefinitionsResponseFieldDefinitionValueTypeCheckbox AccountDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"
const AccountDefinitionsResponseFieldDefinitionValueTypeCurrency AccountDefinitionsResponseFieldDefinitionValueType = "CURRENCY"
const AccountDefinitionsResponseFieldDefinitionValueTypeDate AccountDefinitionsResponseFieldDefinitionValueType = "DATE"
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.

AIFillable stringOptional

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.

One of the following:
const AccountDefinitionsResponseFieldDefinitionAIFillableOn AccountDefinitionsResponseFieldDefinitionAIFillable = "ON"
const AccountDefinitionsResponseFieldDefinitionAIFillableOff AccountDefinitionsResponseFieldDefinitionAIFillable = "OFF"
const AccountDefinitionsResponseFieldDefinitionAIFillableSuggest AccountDefinitionsResponseFieldDefinitionAIFillable = "SUGGEST"
AIFillablePrompt stringOptional

Instructions AI follows when filling this field, or null when none are set. Absent on built-in fields that have no id.

Formula stringOptional

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.

ReadOnly boolOptional

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

ValueSource stringOptional

Whether values are entered (MANUAL) or calculated from a formula (COMPUTED). Absent on built-in fields that have no id.

One of the following:
const AccountDefinitionsResponseFieldDefinitionValueSourceManual AccountDefinitionsResponseFieldDefinitionValueSource = "MANUAL"
const AccountDefinitionsResponseFieldDefinitionValueSourceComputed AccountDefinitionsResponseFieldDefinitionValueSource = "COMPUTED"
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.

Archived bool

Whether the relationship definition is archived.

ArchivedAt Time

When the relationship definition was archived, or null if active.

formatdate-time
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, as it reads from this object type.

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.

GroupKey stringOptional

Key of the relationship group this relationship belongs to, as listed under relationshipGroupDefinitions. Absent when the relationship is not in a group.

Inverse AccountDefinitionsResponseRelationshipDefinitionInverseOptional

How the same relationship reads from the related object type.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const AccountDefinitionsResponseRelationshipDefinitionInverseCardinalityHasOne AccountDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_ONE"
const AccountDefinitionsResponseRelationshipDefinitionInverseCardinalityHasMany AccountDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

RelationshipGroupDefinitions map[string, AccountDefinitionsResponseRelationshipGroupDefinition]

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.

ID string

Unique identifier of the relationship group.

Archived bool

Whether the relationship group is archived.

ArchivedAt Time

When the relationship group was archived, or null if active.

formatdate-time
Inverse AccountDefinitionsResponseRelationshipGroupDefinitionInverse

How the same group reads from the related object type.

Label string

Human-readable display name of the group, as it reads from the related object type.

Label string

Human-readable display name of the group, as it reads from this object type.

ObjectType string

The type of the related object every relationship in the group points to.

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 AccountDeleteResponseFieldValueTypeDate AccountDeleteResponseFieldValueType = "DATE"
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"
Relationships map[string, AccountDeleteResponseRelationship]

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 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 AccountFieldHistoryResponseDataValueTypeDate AccountFieldHistoryResponseDataValueType = "DATE"
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 AccountListResponseDataFieldValueTypeDate AccountListResponseDataFieldValueType = "DATE"
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"
Relationships map[string, AccountListResponseDataRelationship]

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 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 AccountRestoreResponseFieldValueTypeDate AccountRestoreResponseFieldValueType = "DATE"
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"
Relationships map[string, AccountRestoreResponseRelationship]

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 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 AccountRetrieveResponseUnion interface{…}
One of the following:
type AccountRetrieveResponseEntity struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountRetrieveResponseEntityField]

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

Value AccountRetrieveResponseEntityFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type AccountRetrieveResponseEntityFieldValueArray []string
type AccountRetrieveResponseEntityFieldValueAddress 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 AccountRetrieveResponseEntityFieldValueFullName 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 AccountRetrieveResponseEntityFieldValueTypeAddress AccountRetrieveResponseEntityFieldValueType = "ADDRESS"
const AccountRetrieveResponseEntityFieldValueTypeCheckbox AccountRetrieveResponseEntityFieldValueType = "CHECKBOX"
const AccountRetrieveResponseEntityFieldValueTypeCurrency AccountRetrieveResponseEntityFieldValueType = "CURRENCY"
const AccountRetrieveResponseEntityFieldValueTypeDate AccountRetrieveResponseEntityFieldValueType = "DATE"
const AccountRetrieveResponseEntityFieldValueTypeDatetime AccountRetrieveResponseEntityFieldValueType = "DATETIME"
const AccountRetrieveResponseEntityFieldValueTypeEmail AccountRetrieveResponseEntityFieldValueType = "EMAIL"
const AccountRetrieveResponseEntityFieldValueTypeFullName AccountRetrieveResponseEntityFieldValueType = "FULL_NAME"
const AccountRetrieveResponseEntityFieldValueTypeMarkdown AccountRetrieveResponseEntityFieldValueType = "MARKDOWN"
const AccountRetrieveResponseEntityFieldValueTypeMultiSelect AccountRetrieveResponseEntityFieldValueType = "MULTI_SELECT"
const AccountRetrieveResponseEntityFieldValueTypeNumber AccountRetrieveResponseEntityFieldValueType = "NUMBER"
const AccountRetrieveResponseEntityFieldValueTypeSingleSelect AccountRetrieveResponseEntityFieldValueType = "SINGLE_SELECT"
const AccountRetrieveResponseEntityFieldValueTypeSocialHandle AccountRetrieveResponseEntityFieldValueType = "SOCIAL_HANDLE"
const AccountRetrieveResponseEntityFieldValueTypeTelephone AccountRetrieveResponseEntityFieldValueType = "TELEPHONE"
const AccountRetrieveResponseEntityFieldValueTypeText AccountRetrieveResponseEntityFieldValueType = "TEXT"
const AccountRetrieveResponseEntityFieldValueTypeURL AccountRetrieveResponseEntityFieldValueType = "URL"
const AccountRetrieveResponseEntityFieldValueTypeHTML AccountRetrieveResponseEntityFieldValueType = "HTML"
Relationships map[string, AccountRetrieveResponseEntityRelationship]

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 AccountRetrieveResponseEntityRelationshipDirectionsOptional

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 AccountRetrieveResponseEntityRelationshipDirectionsAsDestination

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 AccountRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasOne AccountRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const AccountRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasMany AccountRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource AccountRetrieveResponseEntityRelationshipDirectionsAsSource

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 AccountRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasOne AccountRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const AccountRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasMany AccountRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "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 AccountRetrieveResponseRestricted struct{…}
ID string

Unique identifier for the record, the same ID a full response carries.

Restricted AccountRetrieveResponseRestrictedRestricted

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.

Name string

A label for the record’s type, such as “Restricted opportunity”. Never the record’s name.

Reason string

Why the record is restricted.

One of the following:
const AccountRetrieveResponseRestrictedRestrictedReasonNoAccess AccountRetrieveResponseRestrictedRestrictedReason = "NO_ACCESS"
const AccountRetrieveResponseRestrictedRestrictedReasonInherited AccountRetrieveResponseRestrictedRestrictedReason = "INHERITED"
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 AccountUpdateResponseFieldValueTypeDate AccountUpdateResponseFieldValueType = "DATE"
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"
Relationships map[string, AccountUpdateResponseRelationship]

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 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.