# Task ## Get task field definitions `task.definitions() -> TaskDefinitionsResponse` **get** `/v1/tasks/definitions` Returns the schema for the field and relationship definitions available on tasks. Useful for understanding the shape of task data before creating or updating records. See [Fields and relationships](/using-the-api/fields-and-relationships/) for more details. **[Required scope](/using-the-api/scopes/):** `tasks:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Returns - `class TaskDefinitionsResponse: …` - `field_definitions: Dict[str, FieldDefinitions]` Map of field keys to their definitions, including both system and custom fields. - `description: Optional[str]` Description of the field, or null. - `label: str` Human-readable display name of the field. - `type_configuration: FieldDefinitionsTypeConfiguration` Type-specific configuration (e.g. select options, currency code). - `currency: Optional[str]` ISO 4217 3-letter currency code. - `handle_service: Optional[Literal["TWITTER", "LINKEDIN", "FACEBOOK", "INSTAGRAM"]]` Social platform associated with this handle field. - `"TWITTER"` - `"LINKEDIN"` - `"FACEBOOK"` - `"INSTAGRAM"` - `multiple_values: Optional[bool]` Whether this field accepts multiple values. - `options: Optional[List[FieldDefinitionsTypeConfigurationOption]]` Available options for select fields. - `id: str` Unique identifier of the select option. - `label: str` Human-readable display name of the option. - `description: Optional[str]` Description of the option, or null. - `unique: Optional[bool]` Whether values for this field must be unique. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` Data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `id: Optional[str]` Unique identifier of the field definition. - `read_only: Optional[bool]` `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields. - `object_type: str` The object type these definitions belong to (e.g. `account`). - `relationship_definitions: Dict[str, RelationshipDefinitions]` Map of relationship keys to their definitions. - `cardinality: Literal["HAS_ONE", "HAS_MANY"]` Whether this is a `has_one` or `has_many` relationship. - `"HAS_ONE"` - `"HAS_MANY"` - `description: Optional[str]` Description of the relationship, or null. - `label: str` Human-readable display name of the relationship. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `id: Optional[str]` Unique identifier of the relationship definition. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) task_definitions_response = client.task.definitions() print(task_definitions_response.field_definitions) ``` #### Response ```json { "fieldDefinitions": { "foo": { "description": "description", "label": "label", "typeConfiguration": { "currency": "currency", "handleService": "TWITTER", "multipleValues": true, "options": [ { "id": "id", "label": "label", "description": "description" } ], "unique": true }, "valueType": "ADDRESS", "id": "id", "readOnly": true } }, "objectType": "objectType", "relationshipDefinitions": { "foo": { "cardinality": "HAS_ONE", "description": "description", "label": "label", "objectType": "objectType", "id": "id" } } } ``` ## Create a task `task.create(TaskCreateParams**kwargs) -> TaskCreateResponse` **post** `/v1/tasks` Creates a new task record. The `$title` and `$status` fields and the `$assignedTo` relationship are required. If `$createdBy` is omitted it defaults to the authenticated user. The `$note` relationship is read-only — manage notes via their own relationships. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `tasks:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `fields: Fields` Field values for the new task. Tasks only support the documented system fields, all prefixed with `$` (e.g. `$title`, `$status`). Required: `$title` (string) and `$status` (one of `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`). Call the [definitions endpoint](/api/resources/task/methods/definitions) to discover the available fields. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `status: str` Task status. One of: `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`. - `title: str` Title of the task. - `description: Optional[str]` Description of the task in markdown format. - `due_at: Optional[str]` Due date as an ISO 8601 datetime string. - `relationships: Union[Dict[str, Union[str, Sequence[str]]]]` Relationships to set on the new task. System relationships use a `$` prefix (e.g. `$account`, `$assignedTo`); custom relationships use their bare slug. `$assignedTo` is required. Each value is a single entity ID or an array of IDs. Call the [definitions endpoint](/api/resources/task/methods/definitions) to list available relationship keys. - `Dict[str, Union[str, Sequence[str]]]` - `str` - `Sequence[str]` ### Returns - `class TaskCreateResponse: …` - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, Fields]` 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[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 entity in the Lightfield web app, or null. - `relationships: Dict[str, Relationships]` 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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) task_create_response = client.task.create( fields={ "status": "$status", "title": "$title", }, relationships={ "foo": "string" }, ) print(task_create_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Update a task `task.update(strid, TaskUpdateParams**kwargs) -> TaskUpdateResponse` **post** `/v1/tasks/{id}` Updates an existing task by ID. Only included fields and relationships are modified. The `$note` relationship is read-only — manage notes via their own relationships. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `tasks:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id: str` Unique identifier of the task to update. - `fields: Optional[Fields]` Field values to update — only provided fields are modified; omitted fields are left unchanged. Tasks only support the documented system fields, all prefixed with `$` (e.g. `$title`, `$status`). Call the [definitions endpoint](/api/resources/task/methods/definitions) for available fields. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `description: Optional[str]` Description of the task in markdown format. - `due_at: Optional[str]` Due date as an ISO 8601 datetime string. - `status: Optional[str]` Task status. One of: `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`. - `title: Optional[str]` Title of the task. - `relationships: Optional[Union[Dict[str, RelationshipsUntypedRelationshipsUntypedItem]]]` Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`, `$assignedTo`). Each value is an operation object with `add`, `remove`, or `replace`. - `Dict[str, RelationshipsUntypedRelationshipsUntypedItem]` - `add: Optional[Union[str, Sequence[str]]]` Entity ID(s) to add to the relationship. - `str` - `Sequence[str]` - `remove: Optional[Union[str, Sequence[str]]]` Entity ID(s) to remove from the relationship. - `str` - `Sequence[str]` - `replace: Optional[Union[str, Sequence[str]]]` Entity ID(s) to set as the entire relationship, replacing all existing associations. - `str` - `Sequence[str]` ### Returns - `class TaskUpdateResponse: …` - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, Fields]` 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[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 entity in the Lightfield web app, or null. - `relationships: Dict[str, Relationships]` 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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) task_update_response = client.task.update( id="id", ) print(task_update_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Retrieve a task `task.retrieve(strid) -> TaskRetrieveResponse` **get** `/v1/tasks/{id}` Retrieves a single task by its ID. **[Required scope](/using-the-api/scopes/):** `tasks:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id: str` Unique identifier of the task to retrieve. ### Returns - `class TaskRetrieveResponse: …` - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, Fields]` 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[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 entity in the Lightfield web app, or null. - `relationships: Dict[str, Relationships]` 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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) task_retrieve_response = client.task.retrieve( "id", ) print(task_retrieve_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## List tasks `task.list(TaskListParams**kwargs) -> TaskListResponse` **get** `/v1/tasks` Returns a paginated list of tasks. 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/):** `tasks: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 TaskListResponse: …` - `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", ) task_list_response = client.task.list() print(task_list_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 ### Task Create Response - `class TaskCreateResponse: …` - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, Fields]` 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[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 entity in the Lightfield web app, or null. - `relationships: Dict[str, Relationships]` 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. ### Task Definitions Response - `class TaskDefinitionsResponse: …` - `field_definitions: Dict[str, FieldDefinitions]` Map of field keys to their definitions, including both system and custom fields. - `description: Optional[str]` Description of the field, or null. - `label: str` Human-readable display name of the field. - `type_configuration: FieldDefinitionsTypeConfiguration` Type-specific configuration (e.g. select options, currency code). - `currency: Optional[str]` ISO 4217 3-letter currency code. - `handle_service: Optional[Literal["TWITTER", "LINKEDIN", "FACEBOOK", "INSTAGRAM"]]` Social platform associated with this handle field. - `"TWITTER"` - `"LINKEDIN"` - `"FACEBOOK"` - `"INSTAGRAM"` - `multiple_values: Optional[bool]` Whether this field accepts multiple values. - `options: Optional[List[FieldDefinitionsTypeConfigurationOption]]` Available options for select fields. - `id: str` Unique identifier of the select option. - `label: str` Human-readable display name of the option. - `description: Optional[str]` Description of the option, or null. - `unique: Optional[bool]` Whether values for this field must be unique. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` Data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `id: Optional[str]` Unique identifier of the field definition. - `read_only: Optional[bool]` `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields. - `object_type: str` The object type these definitions belong to (e.g. `account`). - `relationship_definitions: Dict[str, RelationshipDefinitions]` Map of relationship keys to their definitions. - `cardinality: Literal["HAS_ONE", "HAS_MANY"]` Whether this is a `has_one` or `has_many` relationship. - `"HAS_ONE"` - `"HAS_MANY"` - `description: Optional[str]` Description of the relationship, or null. - `label: str` Human-readable display name of the relationship. - `object_type: str` The type of the related object (e.g. `account`, `contact`). - `id: Optional[str]` Unique identifier of the relationship definition. ### Task List Response - `class TaskListResponse: …` - `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. ### Task Retrieve Response - `class TaskRetrieveResponse: …` - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, Fields]` 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[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 entity in the Lightfield web app, or null. - `relationships: Dict[str, Relationships]` 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. ### Task Update Response - `class TaskUpdateResponse: …` - `id: str` Unique identifier for the entity. - `created_at: str` ISO 8601 timestamp of when the entity was created. - `fields: Dict[str, Fields]` 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[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 entity in the Lightfield web app, or null. - `relationships: Dict[str, Relationships]` 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.