API reference
Tasks
Follow-ups, calls and meetings.
GET/tasks
List tasks
Follow-ups, calls and meetings.
Needs the permission tasks:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 200. default 50 |
cursor | query | string | up to 512 characters |
q | query | string | up to 100 characters |
assignee | query | one of me or one of unassigned or one of any or string (uuid) | |
status | query | one of open, done, all | default "open" |
priority | query | one of low, medium, high, urgent | |
kind | query | one of todo, call, email, meeting, follow_up | |
leadId | query | string (uuid) | |
contactId | query | string (uuid) | |
due | query | one of overdue, today, week, none | |
dueFrom | query | string (date-time) | |
dueTo | query | string (date-time) | |
sort | query | one of due, created, priority | default "due" |
order | query | one of asc, desc | default "asc" |
curl -X GET https://crm.anibrosdesign.com/api/v1/tasks \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/tasks
Create a task
Needs the permission tasks:create.
| Parameter | In | Type | Notes |
|---|---|---|---|
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
title required | string | at least 1 characters. up to 200 characters |
description | string or null | |
meetingUrl | string or null | |
meetingMode | one of video, in_person, phone or null | |
location | string or null | |
durationMinutes | integer or null | |
kind | one of todo, call, email, meeting, follow_up | |
priority | one of low, medium, high, urgent | |
dueDate | string (date-time) or null | |
remindBeforeMinutes | integer or null | |
recurrence | object or null | |
recurrence.freq required | one of daily, weekly, monthly | |
recurrence.interval required | integer | at least 1. up to 30 |
assignedTo | string (uuid) or null | |
leadId | string (uuid) or null | |
contactId | string (uuid) or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/tasks \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"title":"text","description":"text","meetingUrl":"text"}'Responses:
201 400 401 402 403 429
POST/tasks/bulk
Bulk (tasks)
Needs the permission tasks:update.
| Body field | Type | Notes |
|---|---|---|
ids required | list of string (uuid) | at least 1 items. up to 100 items |
action required | one of complete, cancel, reassign | |
assignedTo | string (uuid) or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/tasks/bulk \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"ids":["01a15d23-0000-7000-8000-000000000000"],"action":"complete","assignedTo":"01a15d23-0000-7000-8000-000000000000"}'Responses:
200 400 401 402 403 429
GET/tasks/summary
Get summary (tasks)
Needs the permission tasks:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/tasks/summary \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
GET/tasks/{id}
Get a task
Needs the permission tasks:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/tasks/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
PATCH/tasks/{id}
Change a task
Needs the permission tasks:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
title | string | at least 1 characters. up to 200 characters |
description | string or null | |
meetingUrl | string or null | |
meetingMode | one of video, in_person, phone or null | |
location | string or null | |
durationMinutes | integer or null | |
kind | one of todo, call, email, meeting, follow_up | |
priority | one of low, medium, high, urgent | |
dueDate | string (date-time) or null | |
remindBeforeMinutes | integer or null | |
recurrence | object or null | |
recurrence.freq required | one of daily, weekly, monthly | |
recurrence.interval required | integer | at least 1. up to 30 |
assignedTo | string (uuid) or null | |
leadId | string (uuid) or null | |
contactId | string (uuid) or null | |
status | one of pending, in_progress |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/tasks/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"title":"text","description":"text","meetingUrl":"text"}'Responses:
200 400 401 402 403 404 412 429
DELETE/tasks/{id}
Delete a task
Needs the permission tasks:delete.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X DELETE https://crm.anibrosdesign.com/api/v1/tasks/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
POST/tasks/{id}/cancel
Cancel (tasks)
Needs the permission tasks:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/tasks/{id}/cancel \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
POST/tasks/{id}/complete
Mark a task done
Needs the permission tasks:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/tasks/{id}/complete \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
POST/tasks/{id}/reopen
Reopen (tasks)
Needs the permission tasks:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/tasks/{id}/reopen \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
Something missing or unclear? Tell us.