API reference

Tasks

Tasks are calls, meetings and follow-ups assigned to a member, usually with a due time and often tied to a lead, contact or company.

The task object

json

{
  "id": "task_01j8z8a2b4c6d8e0f2g4h6j8k0",
  "title": "Call back about delivery",
  "type": "call",
  "due_at": "2026-09-28T10:00:00+05:00",
  "all_day": false,
  "duration_min": 15,
  "assignee": { "id": "member_01j8z5x7y9z1a3b5c7d9e1f3g5", "name": "Aziz Rahimov" },
  "entity_type": "lead",
  "entity_id": "lead_01j8z7c2d4f6g8h0j2k4m6n8p0",
  "entity_label": "Website order #1042",
  "status": "open",
  "result": "",
  "completed_at": null,
  "snoozed_until": null,
  "created_by": null,
  "created_at": "2026-09-27T09:45:00Z",
  "overdue": false
}

type is call, meeting, follow_up or custom. entity_type is lead, contact, company or null.

Endpoints

GET/v1/taskstasks:read

Parameters: status (open by default, done or all), assignee (all by default, me or a member id), type, entity_type with entity_id (the tasks of one record), due (overdue, today, tomorrow, week, later or none), q, limit, cursor. Open lists leave out snoozed tasks unless snoozed=include.

POST/v1/taskstasks:write

Field	Description
`title`	Required
`type`	`call`, `meeting`, `follow_up` (default) or `custom`
`due_at`	RFC 3339 time with offset, or leave out
`all_day`, `duration_min`	Optional; `all_day` needs `due_at`
`assignee_id`	Required for API keys: the member who should do it (a signed-in member defaults to themselves)
`entity_type`, `entity_id`	Optional: the lead, contact or company it belongs to (needs its read scope)
`entity_label`	Optional display label

Sends task.created.

GET/v1/tasks/{id}tasks:read

PATCH/v1/tasks/{id}tasks:write

Changeable: title, type, due_at, all_day, duration_min, assignee_id.

POST/v1/tasks/{id}/completetasks:write

Optional body {"result": "…"}. Sends task.completed.

POST/v1/tasks/{id}/reopentasks:write

POST/v1/tasks/{id}/snoozetasks:write

Body {"until": "2026-09-29T09:00:00+05:00"}. Only open tasks can be snoozed (task_not_open).

POST/v1/tasks/{id}/rescheduletasks:write

Body: due_at, and optionally all_day and duration_min.

DELETE/v1/tasks/{id}tasks:write

POST/v1/tasks/{id}/restoretasks:write