Skip to content
Lightfield Lightfield
API Reference
Task

Create a task

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: tasks:create

Rate limit category: Write

Body ParametersJSONExpand Collapse
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 to discover the available fields. See 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 to list available relationship keys.

Accepts one of the following:
UnionMember0 = string
UnionMember1 = array of string
ReturnsExpand Collapse
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.

Accepts one of the following:
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.

Accepts one of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
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.

Create a task

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"
          }
        }'
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}
Returns Examples
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}