# List ## Create a list `list.create(ListCreateParams**kwargs) -> ListCreateResponse` **post** `/v1/lists` Creates a new list. The `$name` and `$objectType` fields are required. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `lists:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `fields: Fields` Field values for the new list. Required: `$name` (string) and `$objectType`. - `name: str` Display name of the list. - `object_type: str` The type of entities this list contains. One of `account`, `contact`, or `opportunity`. - `relationships: Optional[Relationships]` Relationships to set on the new list. - `class RelationshipsAccounts: …` - `accounts: Union[str, Sequence[str]]` Account ID(s) to add as initial members. List `$objectType` must be `account`. - `str` - `Sequence[str]` - `class RelationshipsContacts: …` - `contacts: Union[str, Sequence[str]]` Contact ID(s) to add as initial members. List `$objectType` must be `contact`. - `str` - `Sequence[str]` - `class RelationshipsOpportunities: …` - `opportunities: Union[str, Sequence[str]]` Opportunity ID(s) to add as initial members. List `$objectType` must be `opportunity`. - `str` - `Sequence[str]` ### Returns - `class ListCreateResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_create_response = client.list.create( fields={ "name": "$name", "object_type": "$objectType", }, ) print(list_create_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ``` ## Update a list `list.update(strid, ListUpdateParams**kwargs) -> ListUpdateResponse` **post** `/v1/lists/{id}` Updates an existing list by ID. Only included fields are modified. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `lists:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id: str` Unique identifier of the list to update. - `fields: Optional[Fields]` Field values to update — only provided fields are modified; omitted fields are left unchanged. - `name: Optional[str]` Display name of the list. - `relationships: Optional[Relationships]` Relationship operations. Use the key matching the list's `$objectType` (e.g. `$accounts` for an account list). - `class RelationshipsAccounts: …` - `accounts: RelationshipsAccountsAccounts` Add/remove accounts. List `$objectType` must be `account`. - `add: Optional[Union[str, Sequence[str]]]` Entity ID(s) to add to the list. - `str` - `Sequence[str]` - `remove: Optional[Union[str, Sequence[str]]]` Entity ID(s) to remove from the list. - `str` - `Sequence[str]` - `class RelationshipsContacts: …` - `contacts: RelationshipsContactsContacts` Add/remove contacts. List `$objectType` must be `contact`. - `add: Optional[Union[str, Sequence[str]]]` Entity ID(s) to add to the list. - `str` - `Sequence[str]` - `remove: Optional[Union[str, Sequence[str]]]` Entity ID(s) to remove from the list. - `str` - `Sequence[str]` - `class RelationshipsOpportunities: …` - `opportunities: RelationshipsOpportunitiesOpportunities` Add/remove opportunities. List `$objectType` must be `opportunity`. - `add: Optional[Union[str, Sequence[str]]]` Entity ID(s) to add to the list. - `str` - `Sequence[str]` - `remove: Optional[Union[str, Sequence[str]]]` Entity ID(s) to remove from the list. - `str` - `Sequence[str]` ### Returns - `class ListUpdateResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_update_response = client.list.update( id="id", ) print(list_update_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ``` ## Retrieve a list `list.retrieve(strid) -> ListRetrieveResponse` **get** `/v1/lists/{id}` Retrieves a single list by its ID. **[Required scope](/using-the-api/scopes/):** `lists:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id: str` Unique identifier of the list to retrieve. ### Returns - `class ListRetrieveResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_retrieve_response = client.list.retrieve( "id", ) print(list_retrieve_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ``` ## List lists `list.list(ListListParams**kwargs) -> ListListResponse` **get** `/v1/lists` Returns a paginated list of lists. Use `offset` and `limit` to paginate through results. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination. **[Required scope](/using-the-api/scopes/):** `lists:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `limit: Optional[int]` Maximum number of records to return. Defaults to 25, maximum 25. - `offset: Optional[int]` Number of records to skip for pagination. Defaults to 0. ### Returns - `class ListListResponse: …` - `data: List[Data]` Array of list objects for the current page. - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of lists matching the query. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_list_response = client.list.list() print(list_list_response.data) ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ], "object": "object", "totalCount": 0 } ``` ## List accounts in a list `list.list_accounts(strlist_id, ListListAccountsParams**kwargs) -> ListListAccountsResponse` **get** `/v1/lists/{listId}/accounts` Returns a paginated list of accounts that belong to the specified list. **[Required scopes](/using-the-api/scopes/):** `lists:read` and `accounts:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `list_id: str` Unique identifier of the list. - `limit: Optional[int]` Maximum number of records to return. Defaults to 25, maximum 25. - `offset: Optional[int]` Number of records to skip for pagination. Defaults to 0. ### Returns - `class ListListAccountsResponse: …` - `data: List[Data]` Array of entity objects for the current page. - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: str` Whether the relationship is `has_one` or `has_many`. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `values: List[str]` IDs of the related entities. - `updated_at: Optional[str]` ISO 8601 timestamp of when the entity was last updated, or null. - `external_id: Optional[str]` External identifier for the entity, or null if unset. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_list_accounts_response = client.list.list_accounts( list_id="listId", ) print(list_list_accounts_response.data) ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ], "object": "object", "totalCount": 0 } ``` ## List contacts in a list `list.list_contacts(strlist_id, ListListContactsParams**kwargs) -> ListListContactsResponse` **get** `/v1/lists/{listId}/contacts` Returns a paginated list of contacts that belong to the specified list. **[Required scopes](/using-the-api/scopes/):** `lists:read` and `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `list_id: str` Unique identifier of the list. - `limit: Optional[int]` Maximum number of records to return. Defaults to 25, maximum 25. - `offset: Optional[int]` Number of records to skip for pagination. Defaults to 0. ### Returns - `class ListListContactsResponse: …` - `data: List[Data]` Array of entity objects for the current page. - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: str` Whether the relationship is `has_one` or `has_many`. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `values: List[str]` IDs of the related entities. - `updated_at: Optional[str]` ISO 8601 timestamp of when the entity was last updated, or null. - `external_id: Optional[str]` External identifier for the entity, or null if unset. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_list_contacts_response = client.list.list_contacts( list_id="listId", ) print(list_list_contacts_response.data) ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ], "object": "object", "totalCount": 0 } ``` ## List opportunities in a list `list.list_opportunities(strlist_id, ListListOpportunitiesParams**kwargs) -> ListListOpportunitiesResponse` **get** `/v1/lists/{listId}/opportunities` Returns a paginated list of opportunities that belong to the specified list. **[Required scopes](/using-the-api/scopes/):** `lists:read` and `opportunities:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `list_id: str` Unique identifier of the list. - `limit: Optional[int]` Maximum number of records to return. Defaults to 25, maximum 25. - `offset: Optional[int]` Number of records to skip for pagination. Defaults to 0. ### Returns - `class ListListOpportunitiesResponse: …` - `data: List[Data]` Array of entity objects for the current page. - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: str` Whether the relationship is `has_one` or `has_many`. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `values: List[str]` IDs of the related entities. - `updated_at: Optional[str]` ISO 8601 timestamp of when the entity was last updated, or null. - `external_id: Optional[str]` External identifier for the entity, or null if unset. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_list_opportunities_response = client.list.list_opportunities( list_id="listId", ) print(list_list_opportunities_response.data) ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ], "object": "object", "totalCount": 0 } ``` ## Domain Types ### List Create Response - `class ListCreateResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. ### List List Accounts Response - `class ListListAccountsResponse: …` - `data: List[Data]` Array of entity objects for the current page. - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: str` Whether the relationship is `has_one` or `has_many`. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `values: List[str]` IDs of the related entities. - `updated_at: Optional[str]` ISO 8601 timestamp of when the entity was last updated, or null. - `external_id: Optional[str]` External identifier for the entity, or null if unset. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### List List Contacts Response - `class ListListContactsResponse: …` - `data: List[Data]` Array of entity objects for the current page. - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: str` Whether the relationship is `has_one` or `has_many`. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `values: List[str]` IDs of the related entities. - `updated_at: Optional[str]` ISO 8601 timestamp of when the entity was last updated, or null. - `external_id: Optional[str]` External identifier for the entity, or null if unset. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### List List Opportunities Response - `class ListListOpportunitiesResponse: …` - `data: List[Data]` Array of entity objects for the current page. - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: str` Whether the relationship is `has_one` or `has_many`. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `values: List[str]` IDs of the related entities. - `updated_at: Optional[str]` ISO 8601 timestamp of when the entity was last updated, or null. - `external_id: Optional[str]` External identifier for the entity, or null if unset. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### List List Response - `class ListListResponse: …` - `data: List[Data]` Array of list objects for the current page. - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, DataFields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[DataFieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class DataFieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class DataFieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of lists matching the query. ### List Retrieve Response - `class ListRetrieveResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. ### List Update Response - `class ListUpdateResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null.