List
Lists are curated collections of accounts, contacts, or opportunities in Lightfield. Each list contains entities of a single type.
List accounts in a list
List contacts in a list
List opportunities in a list
ModelsExpand Collapse
type ListCreateResponse struct{…}
Fields map[string, ListCreateResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Value ListCreateResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
type ListDeleteResponse struct{…}
Fields map[string, ListDeleteResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Value ListDeleteResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
type ListListAccountsResponse struct{…}
Data []ListListAccountsResponseDataArray of entity objects for the current page.
Array of entity objects for the current page.
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.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Value ListListAccountsResponseDataFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ListListAccountsResponseDataRelationship]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.
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.
Directions ListListAccountsResponseDataRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
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 ListListAccountsResponseDataRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ListListAccountsResponseDataRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ListListContactsResponse struct{…}
Data []ListListContactsResponseDataArray of entity objects for the current page.
Array of entity objects for the current page.
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.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Value ListListContactsResponseDataFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ListListContactsResponseDataRelationship]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.
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.
Directions ListListContactsResponseDataRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
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 ListListContactsResponseDataRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ListListContactsResponseDataRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ListListOpportunitiesResponse struct{…}
Data []ListListOpportunitiesResponseDataArray of entity objects for the current page.
Array of entity objects for the current page.
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.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Value ListListOpportunitiesResponseDataFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
Relationships map[string, ListListOpportunitiesResponseDataRelationship]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.
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.
Directions ListListOpportunitiesResponseDataRelationshipDirectionsOptionalDirectional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.
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 ListListOpportunitiesResponseDataRelationshipDirectionsAsDestinationThe current record is the destination (incoming) endpoint.
The current record is the destination (incoming) endpoint.
AsSource ListListOpportunitiesResponseDataRelationshipDirectionsAsSourceThe current record is the source (outgoing) endpoint.
The current record is the source (outgoing) endpoint.
type ListListResponse struct{…}
Data []ListListResponseDataArray of list objects for the current page.
Array of list objects for the current page.
Fields map[string, ListListResponseDataField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Value ListListResponseDataFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
type ListRetrieveResponse struct{…}
Fields map[string, ListRetrieveResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Value ListRetrieveResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.
ValueType stringThe data type of the field.
The data type of the field.
type ListUpdateResponse struct{…}
Fields map[string, ListUpdateResponseField]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).
Value ListUpdateResponseFieldValueUnionThe field value, or null if unset.
The field value, or null if unset.