List

Lists are curated collections of accounts, contacts, or opportunities in Lightfield. Each list contains entities of a single type.

Create a list

client.List.New(ctx, body) (*ListCreateResponse, error)

POST/v1/lists

Update a list

client.List.Update(ctx, id, body) (*ListUpdateResponse, error)

POST/v1/lists/{id}

Retrieve a list

client.List.Get(ctx, id) (*ListRetrieveResponse, error)

GET/v1/lists/{id}

List lists

client.List.List(ctx, query) (*ListListResponse, error)

GET/v1/lists

List accounts in a list

client.List.ListAccounts(ctx, listID, query) (*ListListAccountsResponse, error)

GET/v1/lists/{listId}/accounts

List contacts in a list

client.List.ListContacts(ctx, listID, query) (*ListListContactsResponse, error)

GET/v1/lists/{listId}/contacts

List opportunities in a list

client.List.ListOpportunities(ctx, listID, query) (*ListListOpportunitiesResponse, error)

GET/v1/lists/{listId}/opportunities

ModelsExpand Collapse

type ListCreateResponse struct{…}

ID string

Unique identifier for the list.

CreatedAt string

ISO 8601 timestamp of when the list was created.

Fields map[string, ListCreateResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).

Value ListCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListCreateResponseFieldValueArray []string

type ListCreateResponseFieldValueAddress 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 ListCreateResponseFieldValueFullName 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 ListCreateResponseFieldValueTypeAddress ListCreateResponseFieldValueType = "ADDRESS"

const ListCreateResponseFieldValueTypeCheckbox ListCreateResponseFieldValueType = "CHECKBOX"

const ListCreateResponseFieldValueTypeCurrency ListCreateResponseFieldValueType = "CURRENCY"

const ListCreateResponseFieldValueTypeDatetime ListCreateResponseFieldValueType = "DATETIME"

const ListCreateResponseFieldValueTypeEmail ListCreateResponseFieldValueType = "EMAIL"

const ListCreateResponseFieldValueTypeFullName ListCreateResponseFieldValueType = "FULL_NAME"

const ListCreateResponseFieldValueTypeMarkdown ListCreateResponseFieldValueType = "MARKDOWN"

const ListCreateResponseFieldValueTypeMultiSelect ListCreateResponseFieldValueType = "MULTI_SELECT"

const ListCreateResponseFieldValueTypeNumber ListCreateResponseFieldValueType = "NUMBER"

const ListCreateResponseFieldValueTypeSingleSelect ListCreateResponseFieldValueType = "SINGLE_SELECT"

const ListCreateResponseFieldValueTypeSocialHandle ListCreateResponseFieldValueType = "SOCIAL_HANDLE"

const ListCreateResponseFieldValueTypeTelephone ListCreateResponseFieldValueType = "TELEPHONE"

const ListCreateResponseFieldValueTypeText ListCreateResponseFieldValueType = "TEXT"

const ListCreateResponseFieldValueTypeURL ListCreateResponseFieldValueType = "URL"

HTTPLink string

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

type ListListAccountsResponse struct{…}

Data []ListListAccountsResponseData

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

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

Value ListListAccountsResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListListAccountsResponseDataFieldValueArray []string

type ListListAccountsResponseDataFieldValueAddress 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 ListListAccountsResponseDataFieldValueFullName 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 ListListAccountsResponseDataFieldValueTypeAddress ListListAccountsResponseDataFieldValueType = "ADDRESS"

const ListListAccountsResponseDataFieldValueTypeCheckbox ListListAccountsResponseDataFieldValueType = "CHECKBOX"

const ListListAccountsResponseDataFieldValueTypeCurrency ListListAccountsResponseDataFieldValueType = "CURRENCY"

const ListListAccountsResponseDataFieldValueTypeDatetime ListListAccountsResponseDataFieldValueType = "DATETIME"

const ListListAccountsResponseDataFieldValueTypeEmail ListListAccountsResponseDataFieldValueType = "EMAIL"

const ListListAccountsResponseDataFieldValueTypeFullName ListListAccountsResponseDataFieldValueType = "FULL_NAME"

const ListListAccountsResponseDataFieldValueTypeMarkdown ListListAccountsResponseDataFieldValueType = "MARKDOWN"

const ListListAccountsResponseDataFieldValueTypeMultiSelect ListListAccountsResponseDataFieldValueType = "MULTI_SELECT"

const ListListAccountsResponseDataFieldValueTypeNumber ListListAccountsResponseDataFieldValueType = "NUMBER"

const ListListAccountsResponseDataFieldValueTypeSingleSelect ListListAccountsResponseDataFieldValueType = "SINGLE_SELECT"

const ListListAccountsResponseDataFieldValueTypeSocialHandle ListListAccountsResponseDataFieldValueType = "SOCIAL_HANDLE"

const ListListAccountsResponseDataFieldValueTypeTelephone ListListAccountsResponseDataFieldValueType = "TELEPHONE"

const ListListAccountsResponseDataFieldValueTypeText ListListAccountsResponseDataFieldValueType = "TEXT"

const ListListAccountsResponseDataFieldValueTypeURL ListListAccountsResponseDataFieldValueType = "URL"

HTTPLink string

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

Relationships map[string, ListListAccountsResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

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.

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 ListListContactsResponse struct{…}

Data []ListListContactsResponseData

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

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

Value ListListContactsResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListListContactsResponseDataFieldValueArray []string

type ListListContactsResponseDataFieldValueAddress 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 ListListContactsResponseDataFieldValueFullName 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 ListListContactsResponseDataFieldValueTypeAddress ListListContactsResponseDataFieldValueType = "ADDRESS"

const ListListContactsResponseDataFieldValueTypeCheckbox ListListContactsResponseDataFieldValueType = "CHECKBOX"

const ListListContactsResponseDataFieldValueTypeCurrency ListListContactsResponseDataFieldValueType = "CURRENCY"

const ListListContactsResponseDataFieldValueTypeDatetime ListListContactsResponseDataFieldValueType = "DATETIME"

const ListListContactsResponseDataFieldValueTypeEmail ListListContactsResponseDataFieldValueType = "EMAIL"

const ListListContactsResponseDataFieldValueTypeFullName ListListContactsResponseDataFieldValueType = "FULL_NAME"

const ListListContactsResponseDataFieldValueTypeMarkdown ListListContactsResponseDataFieldValueType = "MARKDOWN"

const ListListContactsResponseDataFieldValueTypeMultiSelect ListListContactsResponseDataFieldValueType = "MULTI_SELECT"

const ListListContactsResponseDataFieldValueTypeNumber ListListContactsResponseDataFieldValueType = "NUMBER"

const ListListContactsResponseDataFieldValueTypeSingleSelect ListListContactsResponseDataFieldValueType = "SINGLE_SELECT"

const ListListContactsResponseDataFieldValueTypeSocialHandle ListListContactsResponseDataFieldValueType = "SOCIAL_HANDLE"

const ListListContactsResponseDataFieldValueTypeTelephone ListListContactsResponseDataFieldValueType = "TELEPHONE"

const ListListContactsResponseDataFieldValueTypeText ListListContactsResponseDataFieldValueType = "TEXT"

const ListListContactsResponseDataFieldValueTypeURL ListListContactsResponseDataFieldValueType = "URL"

HTTPLink string

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

Relationships map[string, ListListContactsResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

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.

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 ListListOpportunitiesResponse struct{…}

Data []ListListOpportunitiesResponseData

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

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

Value ListListOpportunitiesResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListListOpportunitiesResponseDataFieldValueArray []string

type ListListOpportunitiesResponseDataFieldValueAddress 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 ListListOpportunitiesResponseDataFieldValueFullName 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 ListListOpportunitiesResponseDataFieldValueTypeAddress ListListOpportunitiesResponseDataFieldValueType = "ADDRESS"

const ListListOpportunitiesResponseDataFieldValueTypeCheckbox ListListOpportunitiesResponseDataFieldValueType = "CHECKBOX"

const ListListOpportunitiesResponseDataFieldValueTypeCurrency ListListOpportunitiesResponseDataFieldValueType = "CURRENCY"

const ListListOpportunitiesResponseDataFieldValueTypeDatetime ListListOpportunitiesResponseDataFieldValueType = "DATETIME"

const ListListOpportunitiesResponseDataFieldValueTypeEmail ListListOpportunitiesResponseDataFieldValueType = "EMAIL"

const ListListOpportunitiesResponseDataFieldValueTypeFullName ListListOpportunitiesResponseDataFieldValueType = "FULL_NAME"

const ListListOpportunitiesResponseDataFieldValueTypeMarkdown ListListOpportunitiesResponseDataFieldValueType = "MARKDOWN"

const ListListOpportunitiesResponseDataFieldValueTypeMultiSelect ListListOpportunitiesResponseDataFieldValueType = "MULTI_SELECT"

const ListListOpportunitiesResponseDataFieldValueTypeNumber ListListOpportunitiesResponseDataFieldValueType = "NUMBER"

const ListListOpportunitiesResponseDataFieldValueTypeSingleSelect ListListOpportunitiesResponseDataFieldValueType = "SINGLE_SELECT"

const ListListOpportunitiesResponseDataFieldValueTypeSocialHandle ListListOpportunitiesResponseDataFieldValueType = "SOCIAL_HANDLE"

const ListListOpportunitiesResponseDataFieldValueTypeTelephone ListListOpportunitiesResponseDataFieldValueType = "TELEPHONE"

const ListListOpportunitiesResponseDataFieldValueTypeText ListListOpportunitiesResponseDataFieldValueType = "TEXT"

const ListListOpportunitiesResponseDataFieldValueTypeURL ListListOpportunitiesResponseDataFieldValueType = "URL"

HTTPLink string

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

Relationships map[string, ListListOpportunitiesResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

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.

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 ListListResponse struct{…}

Data []ListListResponseData

Array of list objects for the current page.

ID string

Unique identifier for the list.

CreatedAt string

ISO 8601 timestamp of when the list was created.

Fields map[string, ListListResponseDataField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).

Value ListListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListListResponseDataFieldValueArray []string

type ListListResponseDataFieldValueAddress 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 ListListResponseDataFieldValueFullName 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 ListListResponseDataFieldValueTypeAddress ListListResponseDataFieldValueType = "ADDRESS"

const ListListResponseDataFieldValueTypeCheckbox ListListResponseDataFieldValueType = "CHECKBOX"

const ListListResponseDataFieldValueTypeCurrency ListListResponseDataFieldValueType = "CURRENCY"

const ListListResponseDataFieldValueTypeDatetime ListListResponseDataFieldValueType = "DATETIME"

const ListListResponseDataFieldValueTypeEmail ListListResponseDataFieldValueType = "EMAIL"

const ListListResponseDataFieldValueTypeFullName ListListResponseDataFieldValueType = "FULL_NAME"

const ListListResponseDataFieldValueTypeMarkdown ListListResponseDataFieldValueType = "MARKDOWN"

const ListListResponseDataFieldValueTypeMultiSelect ListListResponseDataFieldValueType = "MULTI_SELECT"

const ListListResponseDataFieldValueTypeNumber ListListResponseDataFieldValueType = "NUMBER"

const ListListResponseDataFieldValueTypeSingleSelect ListListResponseDataFieldValueType = "SINGLE_SELECT"

const ListListResponseDataFieldValueTypeSocialHandle ListListResponseDataFieldValueType = "SOCIAL_HANDLE"

const ListListResponseDataFieldValueTypeTelephone ListListResponseDataFieldValueType = "TELEPHONE"

const ListListResponseDataFieldValueTypeText ListListResponseDataFieldValueType = "TEXT"

const ListListResponseDataFieldValueTypeURL ListListResponseDataFieldValueType = "URL"

HTTPLink string

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

Object string

The object type, always "list".

TotalCount int64

Total number of lists matching the query.

minimum0

maximum9007199254740991

type ListRetrieveResponse struct{…}

ID string

Unique identifier for the list.

CreatedAt string

ISO 8601 timestamp of when the list was created.

Fields map[string, ListRetrieveResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).

Value ListRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListRetrieveResponseFieldValueArray []string

type ListRetrieveResponseFieldValueAddress 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 ListRetrieveResponseFieldValueFullName 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 ListRetrieveResponseFieldValueTypeAddress ListRetrieveResponseFieldValueType = "ADDRESS"

const ListRetrieveResponseFieldValueTypeCheckbox ListRetrieveResponseFieldValueType = "CHECKBOX"

const ListRetrieveResponseFieldValueTypeCurrency ListRetrieveResponseFieldValueType = "CURRENCY"

const ListRetrieveResponseFieldValueTypeDatetime ListRetrieveResponseFieldValueType = "DATETIME"

const ListRetrieveResponseFieldValueTypeEmail ListRetrieveResponseFieldValueType = "EMAIL"

const ListRetrieveResponseFieldValueTypeFullName ListRetrieveResponseFieldValueType = "FULL_NAME"

const ListRetrieveResponseFieldValueTypeMarkdown ListRetrieveResponseFieldValueType = "MARKDOWN"

const ListRetrieveResponseFieldValueTypeMultiSelect ListRetrieveResponseFieldValueType = "MULTI_SELECT"

const ListRetrieveResponseFieldValueTypeNumber ListRetrieveResponseFieldValueType = "NUMBER"

const ListRetrieveResponseFieldValueTypeSingleSelect ListRetrieveResponseFieldValueType = "SINGLE_SELECT"

const ListRetrieveResponseFieldValueTypeSocialHandle ListRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const ListRetrieveResponseFieldValueTypeTelephone ListRetrieveResponseFieldValueType = "TELEPHONE"

const ListRetrieveResponseFieldValueTypeText ListRetrieveResponseFieldValueType = "TEXT"

const ListRetrieveResponseFieldValueTypeURL ListRetrieveResponseFieldValueType = "URL"

HTTPLink string

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

type ListUpdateResponse struct{…}

ID string

Unique identifier for the list.

CreatedAt string

ISO 8601 timestamp of when the list was created.

Fields map[string, ListUpdateResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).

Value ListUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListUpdateResponseFieldValueArray []string

type ListUpdateResponseFieldValueAddress 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 ListUpdateResponseFieldValueFullName 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 ListUpdateResponseFieldValueTypeAddress ListUpdateResponseFieldValueType = "ADDRESS"

const ListUpdateResponseFieldValueTypeCheckbox ListUpdateResponseFieldValueType = "CHECKBOX"

const ListUpdateResponseFieldValueTypeCurrency ListUpdateResponseFieldValueType = "CURRENCY"

const ListUpdateResponseFieldValueTypeDatetime ListUpdateResponseFieldValueType = "DATETIME"

const ListUpdateResponseFieldValueTypeEmail ListUpdateResponseFieldValueType = "EMAIL"

const ListUpdateResponseFieldValueTypeFullName ListUpdateResponseFieldValueType = "FULL_NAME"

const ListUpdateResponseFieldValueTypeMarkdown ListUpdateResponseFieldValueType = "MARKDOWN"

const ListUpdateResponseFieldValueTypeMultiSelect ListUpdateResponseFieldValueType = "MULTI_SELECT"

const ListUpdateResponseFieldValueTypeNumber ListUpdateResponseFieldValueType = "NUMBER"

const ListUpdateResponseFieldValueTypeSingleSelect ListUpdateResponseFieldValueType = "SINGLE_SELECT"

const ListUpdateResponseFieldValueTypeSocialHandle ListUpdateResponseFieldValueType = "SOCIAL_HANDLE"

const ListUpdateResponseFieldValueTypeTelephone ListUpdateResponseFieldValueType = "TELEPHONE"

const ListUpdateResponseFieldValueTypeText ListUpdateResponseFieldValueType = "TEXT"

const ListUpdateResponseFieldValueTypeURL ListUpdateResponseFieldValueType = "URL"

HTTPLink string

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