task

idinteger

The ID of the task

namestring

descriptionstring

notesstring

task_typestring

The key of a task type, not its id

Example: follow_up

statusstring

Possible values: [pending, in_progress, completed, cancelled]

prioritystring

Possible values: [low, medium, high]

due_atinteger

Unix timestamp of the deadline

start_atinteger

Unix timestamp of when the work starts, used when the task is on the calendar

recurrence_intervalinteger

How many units between repeats. Null for a task that does not repeat.

recurrence_unitstring

Possible values: [day, week, month]

completed_atinteger

Unix timestamp of completion

reminder_atinteger

Unix timestamp of the reminder. Only the primary owner is reminded.

overdueboolean

Past its deadline and not completed. Computed, not stored.

automatedboolean

Whether an automation rule opened this task rather than a person

positioninteger

Order of the card inside its stage, on a pipeline that accepts tasks

deal_idinteger

The deal this task is about. Null for a task that stands on its own.

deal_pipeline_idinteger

deal_stage_idinteger

contact_idinteger

organization_idinteger

owner_idinteger

The user responsible. Only the owner gets the reminder.

created_by_idinteger

assignee_idsinteger[]

Co-owners. They see the task but are not reminded.

custom_fieldsobject

checklist object[]

Array [

idstring

contentstring

completedboolean

]

labelsstring[]

files object[]

Attachments

Array [

idinteger

Pass this in remove_file_ids to detach it

filenamestring

byte_sizeinteger

urlstring

]

created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of the last update

owner object

Present when the task has an owner

idinteger

namestring

avatar_urlstring

assignees object[]

Array [

idinteger

namestring

avatar_urlstring

]

deal object

Present when the task belongs to a deal

idinteger

namestring

contact object

Present when the task is about a contact

idinteger

namestring

emailstring

organization object

Present when the task belongs to a company

idinteger

namestring

task

{
  "id": 0,
  "name": "string",
  "description": "string",
  "notes": "string",
  "task_type": "follow_up",
  "status": "pending",
  "priority": "low",
  "due_at": 0,
  "start_at": 0,
  "recurrence_interval": 0,
  "recurrence_unit": "day",
  "completed_at": 0,
  "reminder_at": 0,
  "overdue": true,
  "automated": true,
  "position": 0,
  "deal_id": 0,
  "deal_pipeline_id": 0,
  "deal_stage_id": 0,
  "contact_id": 0,
  "organization_id": 0,
  "owner_id": 0,
  "created_by_id": 0,
  "assignee_ids": [
    0
  ],
  "custom_fields": {},
  "checklist": [
    {
      "id": "string",
      "content": "string",
      "completed": true
    }
  ],
  "labels": [
    "string"
  ],
  "files": [
    {
      "id": 0,
      "filename": "string",
      "byte_size": 0,
      "url": "string"
    }
  ],
  "created_at": 0,
  "updated_at": 0,
  "owner": {
    "id": 0,
    "name": "string",
    "avatar_url": "string"
  },
  "assignees": [
    {
      "id": 0,
      "name": "string",
      "avatar_url": "string"
    }
  ],
  "deal": {
    "id": 0,
    "name": "string"
  },
  "contact": {
    "id": 0,
    "name": "string",
    "email": "string"
  },
  "organization": {
    "id": 0,
    "name": "string"
  }
}