Object

Custom objects and relationships are available on Pro and Growth plans. Records can be fetched and manipulated via these endpoints, and definitions can be fetched to discover the available custom object types in the system.

Create a custom object record

client.Object.New(ctx, entitySlug, body) (*ObjectCreateResponse, error)

POST/v1/objects/{entitySlug}/values

Get a custom object record

client.Object.Get(ctx, id, query) (*ObjectRetrieveResponse, error)

GET/v1/objects/{entitySlug}/values/{id}

Update a custom object record

client.Object.Update(ctx, id, params) (*ObjectUpdateResponse, error)

POST/v1/objects/{entitySlug}/values/{id}

Delete a custom object record

client.Object.Delete(ctx, id, params) (*ObjectDeleteResponse, error)

DELETE/v1/objects/{entitySlug}/values/{id}

Restore a custom object record

client.Object.Restore(ctx, id, params) (*ObjectRestoreResponse, error)

POST/v1/objects/{entitySlug}/values/{id}/restore

List custom object records

client.Object.List(ctx, entitySlug, query) (*ObjectListResponse, error)

GET/v1/objects/{entitySlug}

Get definitions for a custom object type

client.Object.Definitions(ctx, entitySlug) (*ObjectDefinitionsResponse, error)

GET/v1/objects/{entitySlug}/definitions

List custom object types

client.Object.ListDefinitions(ctx) (*ObjectListDefinitionsResponse, error)

GET/v1/objects

Get field value history for a custom object record

client.Object.FieldHistory(ctx, fieldKey, params) (*ObjectFieldHistoryResponse, error)

GET/v1/objects/{entitySlug}/values/{id}/fields/{fieldKey}/history

ModelsExpand Collapse

type ObjectCreateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectCreateResponseField]

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

Value ObjectCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectCreateResponseFieldValueArray []string

type ObjectCreateResponseFieldValueAddress 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 ObjectCreateResponseFieldValueFullName 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 ObjectCreateResponseFieldValueTypeAddress ObjectCreateResponseFieldValueType = "ADDRESS"

const ObjectCreateResponseFieldValueTypeCheckbox ObjectCreateResponseFieldValueType = "CHECKBOX"

const ObjectCreateResponseFieldValueTypeCurrency ObjectCreateResponseFieldValueType = "CURRENCY"

const ObjectCreateResponseFieldValueTypeDatetime ObjectCreateResponseFieldValueType = "DATETIME"

const ObjectCreateResponseFieldValueTypeEmail ObjectCreateResponseFieldValueType = "EMAIL"

const ObjectCreateResponseFieldValueTypeFullName ObjectCreateResponseFieldValueType = "FULL_NAME"

const ObjectCreateResponseFieldValueTypeMarkdown ObjectCreateResponseFieldValueType = "MARKDOWN"

const ObjectCreateResponseFieldValueTypeMultiSelect ObjectCreateResponseFieldValueType = "MULTI_SELECT"

const ObjectCreateResponseFieldValueTypeNumber ObjectCreateResponseFieldValueType = "NUMBER"

const ObjectCreateResponseFieldValueTypeSingleSelect ObjectCreateResponseFieldValueType = "SINGLE_SELECT"

const ObjectCreateResponseFieldValueTypeSocialHandle ObjectCreateResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectCreateResponseFieldValueTypeTelephone ObjectCreateResponseFieldValueType = "TELEPHONE"

const ObjectCreateResponseFieldValueTypeText ObjectCreateResponseFieldValueType = "TEXT"

const ObjectCreateResponseFieldValueTypeURL ObjectCreateResponseFieldValueType = "URL"

const ObjectCreateResponseFieldValueTypeHTML ObjectCreateResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectCreateResponseRelationship]

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 ObjectCreateResponseRelationshipDirectionsOptional

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 ObjectCreateResponseRelationshipDirectionsAsDestination

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 ObjectCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne ObjectCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany ObjectCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectCreateResponseRelationshipDirectionsAsSource

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 ObjectCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne ObjectCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany ObjectCreateResponseRelationshipDirectionsAsSourceCardinality = "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 ObjectDefinitionsResponse struct{…}

FieldDefinitions map[string, ObjectDefinitionsResponseFieldDefinition]

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 ObjectDefinitionsResponseFieldDefinitionTypeConfiguration

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 ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"

MultipleValues boolOptional

Whether this field accepts multiple values.

Options []ObjectDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

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 ObjectDefinitionsResponseFieldDefinitionValueTypeAddress ObjectDefinitionsResponseFieldDefinitionValueType = "ADDRESS"

const ObjectDefinitionsResponseFieldDefinitionValueTypeCheckbox ObjectDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"

const ObjectDefinitionsResponseFieldDefinitionValueTypeCurrency ObjectDefinitionsResponseFieldDefinitionValueType = "CURRENCY"

const ObjectDefinitionsResponseFieldDefinitionValueTypeDatetime ObjectDefinitionsResponseFieldDefinitionValueType = "DATETIME"

const ObjectDefinitionsResponseFieldDefinitionValueTypeEmail ObjectDefinitionsResponseFieldDefinitionValueType = "EMAIL"

const ObjectDefinitionsResponseFieldDefinitionValueTypeFullName ObjectDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"

const ObjectDefinitionsResponseFieldDefinitionValueTypeMarkdown ObjectDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"

const ObjectDefinitionsResponseFieldDefinitionValueTypeMultiSelect ObjectDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"

const ObjectDefinitionsResponseFieldDefinitionValueTypeNumber ObjectDefinitionsResponseFieldDefinitionValueType = "NUMBER"

const ObjectDefinitionsResponseFieldDefinitionValueTypeSingleSelect ObjectDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"

const ObjectDefinitionsResponseFieldDefinitionValueTypeSocialHandle ObjectDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"

const ObjectDefinitionsResponseFieldDefinitionValueTypeTelephone ObjectDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"

const ObjectDefinitionsResponseFieldDefinitionValueTypeText ObjectDefinitionsResponseFieldDefinitionValueType = "TEXT"

const ObjectDefinitionsResponseFieldDefinitionValueTypeURL ObjectDefinitionsResponseFieldDefinitionValueType = "URL"

const ObjectDefinitionsResponseFieldDefinitionValueTypeHTML ObjectDefinitionsResponseFieldDefinitionValueType = "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, ObjectDefinitionsResponseRelationshipDefinition]

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 ObjectDefinitionsResponseRelationshipDefinitionCardinalityHasOne ObjectDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"

const ObjectDefinitionsResponseRelationshipDefinitionCardinalityHasMany ObjectDefinitionsResponseRelationshipDefinitionCardinality = "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 ObjectDefinitionsResponseRelationshipDefinitionDirectionsOptional

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 ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

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 ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"

Label string

Human-readable display name for this endpoint direction.

AsSource ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsSource

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 ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany ObjectDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_MANY"

Label string

Human-readable display name for this endpoint direction.

type ObjectDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectDeleteResponseField]

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

Value ObjectDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectDeleteResponseFieldValueArray []string

type ObjectDeleteResponseFieldValueAddress 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 ObjectDeleteResponseFieldValueFullName 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 ObjectDeleteResponseFieldValueTypeAddress ObjectDeleteResponseFieldValueType = "ADDRESS"

const ObjectDeleteResponseFieldValueTypeCheckbox ObjectDeleteResponseFieldValueType = "CHECKBOX"

const ObjectDeleteResponseFieldValueTypeCurrency ObjectDeleteResponseFieldValueType = "CURRENCY"

const ObjectDeleteResponseFieldValueTypeDatetime ObjectDeleteResponseFieldValueType = "DATETIME"

const ObjectDeleteResponseFieldValueTypeEmail ObjectDeleteResponseFieldValueType = "EMAIL"

const ObjectDeleteResponseFieldValueTypeFullName ObjectDeleteResponseFieldValueType = "FULL_NAME"

const ObjectDeleteResponseFieldValueTypeMarkdown ObjectDeleteResponseFieldValueType = "MARKDOWN"

const ObjectDeleteResponseFieldValueTypeMultiSelect ObjectDeleteResponseFieldValueType = "MULTI_SELECT"

const ObjectDeleteResponseFieldValueTypeNumber ObjectDeleteResponseFieldValueType = "NUMBER"

const ObjectDeleteResponseFieldValueTypeSingleSelect ObjectDeleteResponseFieldValueType = "SINGLE_SELECT"

const ObjectDeleteResponseFieldValueTypeSocialHandle ObjectDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectDeleteResponseFieldValueTypeTelephone ObjectDeleteResponseFieldValueType = "TELEPHONE"

const ObjectDeleteResponseFieldValueTypeText ObjectDeleteResponseFieldValueType = "TEXT"

const ObjectDeleteResponseFieldValueTypeURL ObjectDeleteResponseFieldValueType = "URL"

const ObjectDeleteResponseFieldValueTypeHTML ObjectDeleteResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectDeleteResponseRelationship]

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 ObjectDeleteResponseRelationshipDirectionsOptional

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 ObjectDeleteResponseRelationshipDirectionsAsDestination

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 ObjectDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne ObjectDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany ObjectDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectDeleteResponseRelationshipDirectionsAsSource

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 ObjectDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne ObjectDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany ObjectDeleteResponseRelationshipDirectionsAsSourceCardinality = "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 ObjectFieldHistoryResponse struct{…}

Data []ObjectFieldHistoryResponseData

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 ObjectFieldHistoryResponseDataValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectFieldHistoryResponseDataValueArray []string

type ObjectFieldHistoryResponseDataValueAddress 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 ObjectFieldHistoryResponseDataValueFullName 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 ObjectFieldHistoryResponseDataValueTypeAddress ObjectFieldHistoryResponseDataValueType = "ADDRESS"

const ObjectFieldHistoryResponseDataValueTypeCheckbox ObjectFieldHistoryResponseDataValueType = "CHECKBOX"

const ObjectFieldHistoryResponseDataValueTypeCurrency ObjectFieldHistoryResponseDataValueType = "CURRENCY"

const ObjectFieldHistoryResponseDataValueTypeDatetime ObjectFieldHistoryResponseDataValueType = "DATETIME"

const ObjectFieldHistoryResponseDataValueTypeEmail ObjectFieldHistoryResponseDataValueType = "EMAIL"

const ObjectFieldHistoryResponseDataValueTypeFullName ObjectFieldHistoryResponseDataValueType = "FULL_NAME"

const ObjectFieldHistoryResponseDataValueTypeMarkdown ObjectFieldHistoryResponseDataValueType = "MARKDOWN"

const ObjectFieldHistoryResponseDataValueTypeMultiSelect ObjectFieldHistoryResponseDataValueType = "MULTI_SELECT"

const ObjectFieldHistoryResponseDataValueTypeNumber ObjectFieldHistoryResponseDataValueType = "NUMBER"

const ObjectFieldHistoryResponseDataValueTypeSingleSelect ObjectFieldHistoryResponseDataValueType = "SINGLE_SELECT"

const ObjectFieldHistoryResponseDataValueTypeSocialHandle ObjectFieldHistoryResponseDataValueType = "SOCIAL_HANDLE"

const ObjectFieldHistoryResponseDataValueTypeTelephone ObjectFieldHistoryResponseDataValueType = "TELEPHONE"

const ObjectFieldHistoryResponseDataValueTypeText ObjectFieldHistoryResponseDataValueType = "TEXT"

const ObjectFieldHistoryResponseDataValueTypeURL ObjectFieldHistoryResponseDataValueType = "URL"

const ObjectFieldHistoryResponseDataValueTypeHTML ObjectFieldHistoryResponseDataValueType = "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 ObjectListDefinitionsResponse struct{…}

Data []ObjectListDefinitionsResponseData

All object types available to the caller.

Label string

Human-readable display name.

ObjectType string

The slug used to reference this object type in the API.

type ObjectListResponse struct{…}

Data []ObjectListResponseData

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

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

Value ObjectListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectListResponseDataFieldValueArray []string

type ObjectListResponseDataFieldValueAddress 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 ObjectListResponseDataFieldValueFullName 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 ObjectListResponseDataFieldValueTypeAddress ObjectListResponseDataFieldValueType = "ADDRESS"

const ObjectListResponseDataFieldValueTypeCheckbox ObjectListResponseDataFieldValueType = "CHECKBOX"

const ObjectListResponseDataFieldValueTypeCurrency ObjectListResponseDataFieldValueType = "CURRENCY"

const ObjectListResponseDataFieldValueTypeDatetime ObjectListResponseDataFieldValueType = "DATETIME"

const ObjectListResponseDataFieldValueTypeEmail ObjectListResponseDataFieldValueType = "EMAIL"

const ObjectListResponseDataFieldValueTypeFullName ObjectListResponseDataFieldValueType = "FULL_NAME"

const ObjectListResponseDataFieldValueTypeMarkdown ObjectListResponseDataFieldValueType = "MARKDOWN"

const ObjectListResponseDataFieldValueTypeMultiSelect ObjectListResponseDataFieldValueType = "MULTI_SELECT"

const ObjectListResponseDataFieldValueTypeNumber ObjectListResponseDataFieldValueType = "NUMBER"

const ObjectListResponseDataFieldValueTypeSingleSelect ObjectListResponseDataFieldValueType = "SINGLE_SELECT"

const ObjectListResponseDataFieldValueTypeSocialHandle ObjectListResponseDataFieldValueType = "SOCIAL_HANDLE"

const ObjectListResponseDataFieldValueTypeTelephone ObjectListResponseDataFieldValueType = "TELEPHONE"

const ObjectListResponseDataFieldValueTypeText ObjectListResponseDataFieldValueType = "TEXT"

const ObjectListResponseDataFieldValueTypeURL ObjectListResponseDataFieldValueType = "URL"

const ObjectListResponseDataFieldValueTypeHTML ObjectListResponseDataFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectListResponseDataRelationship]

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 ObjectListResponseDataRelationshipDirectionsOptional

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 ObjectListResponseDataRelationshipDirectionsAsDestination

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 ObjectListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne ObjectListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany ObjectListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectListResponseDataRelationshipDirectionsAsSource

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 ObjectListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne ObjectListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany ObjectListResponseDataRelationshipDirectionsAsSourceCardinality = "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 ObjectRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectRestoreResponseField]

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

Value ObjectRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectRestoreResponseFieldValueArray []string

type ObjectRestoreResponseFieldValueAddress 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 ObjectRestoreResponseFieldValueFullName 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 ObjectRestoreResponseFieldValueTypeAddress ObjectRestoreResponseFieldValueType = "ADDRESS"

const ObjectRestoreResponseFieldValueTypeCheckbox ObjectRestoreResponseFieldValueType = "CHECKBOX"

const ObjectRestoreResponseFieldValueTypeCurrency ObjectRestoreResponseFieldValueType = "CURRENCY"

const ObjectRestoreResponseFieldValueTypeDatetime ObjectRestoreResponseFieldValueType = "DATETIME"

const ObjectRestoreResponseFieldValueTypeEmail ObjectRestoreResponseFieldValueType = "EMAIL"

const ObjectRestoreResponseFieldValueTypeFullName ObjectRestoreResponseFieldValueType = "FULL_NAME"

const ObjectRestoreResponseFieldValueTypeMarkdown ObjectRestoreResponseFieldValueType = "MARKDOWN"

const ObjectRestoreResponseFieldValueTypeMultiSelect ObjectRestoreResponseFieldValueType = "MULTI_SELECT"

const ObjectRestoreResponseFieldValueTypeNumber ObjectRestoreResponseFieldValueType = "NUMBER"

const ObjectRestoreResponseFieldValueTypeSingleSelect ObjectRestoreResponseFieldValueType = "SINGLE_SELECT"

const ObjectRestoreResponseFieldValueTypeSocialHandle ObjectRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectRestoreResponseFieldValueTypeTelephone ObjectRestoreResponseFieldValueType = "TELEPHONE"

const ObjectRestoreResponseFieldValueTypeText ObjectRestoreResponseFieldValueType = "TEXT"

const ObjectRestoreResponseFieldValueTypeURL ObjectRestoreResponseFieldValueType = "URL"

const ObjectRestoreResponseFieldValueTypeHTML ObjectRestoreResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectRestoreResponseRelationship]

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 ObjectRestoreResponseRelationshipDirectionsOptional

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 ObjectRestoreResponseRelationshipDirectionsAsDestination

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 ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectRestoreResponseRelationshipDirectionsAsSource

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 ObjectRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne ObjectRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany ObjectRestoreResponseRelationshipDirectionsAsSourceCardinality = "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 ObjectRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectRetrieveResponseField]

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

Value ObjectRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectRetrieveResponseFieldValueArray []string

type ObjectRetrieveResponseFieldValueAddress 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 ObjectRetrieveResponseFieldValueFullName 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 ObjectRetrieveResponseFieldValueTypeAddress ObjectRetrieveResponseFieldValueType = "ADDRESS"

const ObjectRetrieveResponseFieldValueTypeCheckbox ObjectRetrieveResponseFieldValueType = "CHECKBOX"

const ObjectRetrieveResponseFieldValueTypeCurrency ObjectRetrieveResponseFieldValueType = "CURRENCY"

const ObjectRetrieveResponseFieldValueTypeDatetime ObjectRetrieveResponseFieldValueType = "DATETIME"

const ObjectRetrieveResponseFieldValueTypeEmail ObjectRetrieveResponseFieldValueType = "EMAIL"

const ObjectRetrieveResponseFieldValueTypeFullName ObjectRetrieveResponseFieldValueType = "FULL_NAME"

const ObjectRetrieveResponseFieldValueTypeMarkdown ObjectRetrieveResponseFieldValueType = "MARKDOWN"

const ObjectRetrieveResponseFieldValueTypeMultiSelect ObjectRetrieveResponseFieldValueType = "MULTI_SELECT"

const ObjectRetrieveResponseFieldValueTypeNumber ObjectRetrieveResponseFieldValueType = "NUMBER"

const ObjectRetrieveResponseFieldValueTypeSingleSelect ObjectRetrieveResponseFieldValueType = "SINGLE_SELECT"

const ObjectRetrieveResponseFieldValueTypeSocialHandle ObjectRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectRetrieveResponseFieldValueTypeTelephone ObjectRetrieveResponseFieldValueType = "TELEPHONE"

const ObjectRetrieveResponseFieldValueTypeText ObjectRetrieveResponseFieldValueType = "TEXT"

const ObjectRetrieveResponseFieldValueTypeURL ObjectRetrieveResponseFieldValueType = "URL"

const ObjectRetrieveResponseFieldValueTypeHTML ObjectRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectRetrieveResponseRelationship]

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 ObjectRetrieveResponseRelationshipDirectionsOptional

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 ObjectRetrieveResponseRelationshipDirectionsAsDestination

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 ObjectRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne ObjectRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany ObjectRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectRetrieveResponseRelationshipDirectionsAsSource

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 ObjectRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne ObjectRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany ObjectRetrieveResponseRelationshipDirectionsAsSourceCardinality = "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 ObjectUpdateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectUpdateResponseField]

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

Value ObjectUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectUpdateResponseFieldValueArray []string

type ObjectUpdateResponseFieldValueAddress 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 ObjectUpdateResponseFieldValueFullName 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 ObjectUpdateResponseFieldValueTypeAddress ObjectUpdateResponseFieldValueType = "ADDRESS"

const ObjectUpdateResponseFieldValueTypeCheckbox ObjectUpdateResponseFieldValueType = "CHECKBOX"

const ObjectUpdateResponseFieldValueTypeCurrency ObjectUpdateResponseFieldValueType = "CURRENCY"

const ObjectUpdateResponseFieldValueTypeDatetime ObjectUpdateResponseFieldValueType = "DATETIME"

const ObjectUpdateResponseFieldValueTypeEmail ObjectUpdateResponseFieldValueType = "EMAIL"

const ObjectUpdateResponseFieldValueTypeFullName ObjectUpdateResponseFieldValueType = "FULL_NAME"

const ObjectUpdateResponseFieldValueTypeMarkdown ObjectUpdateResponseFieldValueType = "MARKDOWN"

const ObjectUpdateResponseFieldValueTypeMultiSelect ObjectUpdateResponseFieldValueType = "MULTI_SELECT"

const ObjectUpdateResponseFieldValueTypeNumber ObjectUpdateResponseFieldValueType = "NUMBER"

const ObjectUpdateResponseFieldValueTypeSingleSelect ObjectUpdateResponseFieldValueType = "SINGLE_SELECT"

const ObjectUpdateResponseFieldValueTypeSocialHandle ObjectUpdateResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectUpdateResponseFieldValueTypeTelephone ObjectUpdateResponseFieldValueType = "TELEPHONE"

const ObjectUpdateResponseFieldValueTypeText ObjectUpdateResponseFieldValueType = "TEXT"

const ObjectUpdateResponseFieldValueTypeURL ObjectUpdateResponseFieldValueType = "URL"

const ObjectUpdateResponseFieldValueTypeHTML ObjectUpdateResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectUpdateResponseRelationship]

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 ObjectUpdateResponseRelationshipDirectionsOptional

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 ObjectUpdateResponseRelationshipDirectionsAsDestination

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 ObjectUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne ObjectUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany ObjectUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectUpdateResponseRelationshipDirectionsAsSource

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 ObjectUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne ObjectUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany ObjectUpdateResponseRelationshipDirectionsAsSourceCardinality = "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.