# Task
## Definitions
**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
- `TaskDefinitionsResponse = object { fieldDefinitions, objectType, relationshipDefinitions }`
- `fieldDefinitions: map[object { description, label, typeConfiguration, 3 more } ]`
Map of field keys to their definitions, including both system and custom fields.
- `description: string`
Description of the field, or null.
- `label: string`
Human-readable display name of the field.
- `typeConfiguration: object { currency, handleService, multipleValues, 2 more }`
Type-specific configuration (e.g. select options, currency code).
- `currency: optional string`
ISO 4217 3-letter currency code.
- `handleService: optional "TWITTER" or "LINKEDIN" or "FACEBOOK" or "INSTAGRAM"`
Social platform associated with this handle field.
- `"TWITTER"`
- `"LINKEDIN"`
- `"FACEBOOK"`
- `"INSTAGRAM"`
- `multipleValues: optional boolean`
Whether this field accepts multiple values.
- `options: optional array of object { id, label, description }`
Available options for select fields.
- `id: string`
Unique identifier of the select option.
- `label: string`
Human-readable display name of the option.
- `description: optional string`
Description of the option, or null.
- `unique: optional boolean`
Whether values for this field must be unique.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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 string`
Unique identifier of the field definition.
- `readOnly: optional boolean`
`true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields.
- `objectType: string`
The object type these definitions belong to (e.g. `account`).
- `relationshipDefinitions: map[object { cardinality, description, label, 2 more } ]`
Map of relationship keys to their definitions.
- `cardinality: "HAS_ONE" or "HAS_MANY"`
Whether this is a `has_one` or `has_many` relationship.
- `"HAS_ONE"`
- `"HAS_MANY"`
- `description: string`
Description of the relationship, or null.
- `label: string`
Human-readable display name of the relationship.
- `objectType: string`
The type of the related object (e.g. `account`, `contact`).
- `id: optional string`
Unique identifier of the relationship definition.
### Example
```http
curl https://api.lightfield.app/v1/tasks/definitions \
-H 'Lightfield-Version: 2026-03-01' \
-H "Authorization: Bearer $API_KEY"
```
## Create
**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
### Body Parameters
- `fields: object { "$status", "$title", "$description", "$dueAt" }`
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": string`
Task status. One of: `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`.
- `"$title": string`
Title of the task.
- `"$description": optional string`
Description of the task in markdown format.
- `"$dueAt": optional string`
Due date as an ISO 8601 datetime string.
- `relationships: map[string or array of string]`
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.
- `UnionMember0 = string`
- `UnionMember1 = array of string`
### Returns
- `TaskCreateResponse = object { id, createdAt, fields, 4 more }`
- `id: string`
Unique identifier for the entity.
- `createdAt: string`
ISO 8601 timestamp of when the entity was created.
- `fields: map[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
### Example
```http
curl https://api.lightfield.app/v1/tasks \
-H 'Content-Type: application/json' \
-H 'Lightfield-Version: 2026-03-01' \
-H "Authorization: Bearer $API_KEY" \
-d '{
"fields": {
"$status": "$status",
"$title": "$title"
},
"relationships": {
"foo": "string"
}
}'
```
## Update
**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
### Path Parameters
- `id: string`
Unique identifier of the task to update.
### Body Parameters
- `fields: optional object { "$description", "$dueAt", "$status", "$title" }`
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 string`
Description of the task in markdown format.
- `"$dueAt": optional string`
Due date as an ISO 8601 datetime string.
- `"$status": optional string`
Task status. One of: `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`.
- `"$title": optional string`
Title of the task.
- `relationships: optional map[object { add, remove, replace } ]`
Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`, `$assignedTo`). Each value is an operation object with `add`, `remove`, or `replace`.
- `add: optional string or array of string`
Entity ID(s) to add to the relationship.
- `UnionMember0 = string`
- `UnionMember1 = array of string`
- `remove: optional string or array of string`
Entity ID(s) to remove from the relationship.
- `UnionMember0 = string`
- `UnionMember1 = array of string`
- `replace: optional string or array of string`
Entity ID(s) to set as the entire relationship, replacing all existing associations.
- `UnionMember0 = string`
- `UnionMember1 = array of string`
### Returns
- `TaskUpdateResponse = object { id, createdAt, fields, 4 more }`
- `id: string`
Unique identifier for the entity.
- `createdAt: string`
ISO 8601 timestamp of when the entity was created.
- `fields: map[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
### Example
```http
curl https://api.lightfield.app/v1/tasks/$ID \
-H 'Content-Type: application/json' \
-H 'Lightfield-Version: 2026-03-01' \
-H "Authorization: Bearer $API_KEY" \
-d '{}'
```
## Retrieve
**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
### Path Parameters
- `id: string`
Unique identifier of the task to retrieve.
### Returns
- `TaskRetrieveResponse = object { id, createdAt, fields, 4 more }`
- `id: string`
Unique identifier for the entity.
- `createdAt: string`
ISO 8601 timestamp of when the entity was created.
- `fields: map[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
### Example
```http
curl https://api.lightfield.app/v1/tasks/$ID \
-H 'Lightfield-Version: 2026-03-01' \
-H "Authorization: Bearer $API_KEY"
```
## List
**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
### Query Parameters
- `limit: optional number`
Maximum number of records to return. Defaults to 25, maximum 25.
- `offset: optional number`
Number of records to skip for pagination. Defaults to 0.
### Returns
- `TaskListResponse = object { data, object, totalCount }`
- `data: array of object { id, createdAt, fields, 4 more }`
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[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
- `object: string`
The object type, always `"list"`.
- `totalCount: number`
Total number of entities matching the query.
### Example
```http
curl https://api.lightfield.app/v1/tasks \
-H 'Lightfield-Version: 2026-03-01' \
-H "Authorization: Bearer $API_KEY"
```
## Domain Types
### Task Create Response
- `TaskCreateResponse = object { id, createdAt, fields, 4 more }`
- `id: string`
Unique identifier for the entity.
- `createdAt: string`
ISO 8601 timestamp of when the entity was created.
- `fields: map[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
### Task Definitions Response
- `TaskDefinitionsResponse = object { fieldDefinitions, objectType, relationshipDefinitions }`
- `fieldDefinitions: map[object { description, label, typeConfiguration, 3 more } ]`
Map of field keys to their definitions, including both system and custom fields.
- `description: string`
Description of the field, or null.
- `label: string`
Human-readable display name of the field.
- `typeConfiguration: object { currency, handleService, multipleValues, 2 more }`
Type-specific configuration (e.g. select options, currency code).
- `currency: optional string`
ISO 4217 3-letter currency code.
- `handleService: optional "TWITTER" or "LINKEDIN" or "FACEBOOK" or "INSTAGRAM"`
Social platform associated with this handle field.
- `"TWITTER"`
- `"LINKEDIN"`
- `"FACEBOOK"`
- `"INSTAGRAM"`
- `multipleValues: optional boolean`
Whether this field accepts multiple values.
- `options: optional array of object { id, label, description }`
Available options for select fields.
- `id: string`
Unique identifier of the select option.
- `label: string`
Human-readable display name of the option.
- `description: optional string`
Description of the option, or null.
- `unique: optional boolean`
Whether values for this field must be unique.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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 string`
Unique identifier of the field definition.
- `readOnly: optional boolean`
`true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields.
- `objectType: string`
The object type these definitions belong to (e.g. `account`).
- `relationshipDefinitions: map[object { cardinality, description, label, 2 more } ]`
Map of relationship keys to their definitions.
- `cardinality: "HAS_ONE" or "HAS_MANY"`
Whether this is a `has_one` or `has_many` relationship.
- `"HAS_ONE"`
- `"HAS_MANY"`
- `description: string`
Description of the relationship, or null.
- `label: string`
Human-readable display name of the relationship.
- `objectType: string`
The type of the related object (e.g. `account`, `contact`).
- `id: optional string`
Unique identifier of the relationship definition.
### Task List Response
- `TaskListResponse = object { data, object, totalCount }`
- `data: array of object { id, createdAt, fields, 4 more }`
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[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
- `object: string`
The object type, always `"list"`.
- `totalCount: number`
Total number of entities matching the query.
### Task Retrieve Response
- `TaskRetrieveResponse = object { id, createdAt, fields, 4 more }`
- `id: string`
Unique identifier for the entity.
- `createdAt: string`
ISO 8601 timestamp of when the entity was created.
- `fields: map[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.
### Task Update Response
- `TaskUpdateResponse = object { id, createdAt, fields, 4 more }`
- `id: string`
Unique identifier for the entity.
- `createdAt: string`
ISO 8601 timestamp of when the entity was created.
- `fields: map[object { value, valueType } ]`
Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
- `value: string or number or boolean or 3 more`
The field value, or null if unset.
- `UnionMember0 = string`
- `UnionMember1 = number`
- `UnionMember2 = boolean`
- `UnionMember3 = array of string`
- `Address = object { city, country, latitude, 5 more }`
- `city: optional string`
City name.
- `country: optional string`
2-letter ISO 3166-1 alpha-2 country code.
- `latitude: optional number`
Latitude coordinate.
- `longitude: optional number`
Longitude coordinate.
- `postalCode: optional string`
Postal or ZIP code.
- `state: optional string`
State or province.
- `street: optional string`
Street address line 1.
- `street2: optional string`
Street address line 2.
- `FullName = object { firstName, lastName }`
- `firstName: optional string`
The contact's first name.
- `lastName: optional string`
The contact's last name.
- `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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"`
- `httpLink: string`
URL to view the entity in the Lightfield web app, or null.
- `relationships: map[object { cardinality, objectType, values } ]`
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: array of string`
IDs of the related entities.
- `updatedAt: string`
ISO 8601 timestamp of when the entity was last updated, or null.
- `externalId: optional string`
External identifier for the entity, or null if unset.