List Tasks
GET/external/v1/tasksReturns a paginated list of tasks: to-dos with a due date, a type and one or more assignees. A task can belong to an opportunity, to a contact, to a playbook run (one task per step), or stand alone as a team task.
Authentication
Requires tasks:read permission.
What the key can see
A key sees the same tasks as the user who created it sees in the app. Admins and supervisors see every task of the account. Other users see the tasks of opportunities they own plus the tasks assigned to them.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number |
limit | integer | 50 | Items per page (1-100) |
status | string | - | Comma-separated: pending, in_progress, completed, cancelled. Without it, every status except cancelled |
assignee_id | string | - | Only tasks assigned to this user (see List Users) |
contact_id | string | - | Only tasks of this contact (directly or through its opportunity) |
opportunity_id | string | - | Only tasks of this opportunity |
playbook_run_id | string | - | Only the steps of this playbook run |
task_pipeline_id | string | - | Only tasks in this task pipeline (see Task pipelines and labels) |
task_type | string | - | Comma-separated: call, meeting, email, follow_up, proposal, communication, internal_task, other |
priority | string | - | Comma-separated: low, medium, high, urgent |
overdue | boolean | - | true = only open tasks past their due date |
search | string | - | Partial match on the title, or a task number (#123) |
due_after / due_before | string (ISO 8601) | - | Due date range |
created_after / created_before | string (ISO 8601) | - | Creation range |
updated_after / updated_before | string (ISO 8601) | - | Last-update range (incremental sync) |
sort_by | string | due_date | due_date, created_at or updated_at. Tasks without a due date come last |
sort_order | string | asc for due_date, desc otherwise | asc or desc |
Today's queue of a seller
GET /tasks?assignee_id=USER_ID&status=pending,in_progress&due_before=2026-10-19T23:59:59-03:00
An unknown status, task_type or priority, an id that is not a UUID or an invalid date returns 400 VALIDATION_ERROR.
Request
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/tasks?status=pending,in_progress&overdue=true" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const response = await axios.get('https://app.getraze.com/external/v1/tasks', {
headers: { 'X-API-Key': 'YOUR_API_KEY' },
params: { status: 'pending,in_progress', overdue: true }
});
console.log(response.data);python
import requests
response = requests.get(
'https://app.getraze.com/external/v1/tasks',
headers={'X-API-Key': 'YOUR_API_KEY'},
params={'status': 'pending,in_progress', 'overdue': 'true'}
)
print(response.json())Response
json
{
"success": true,
"data": [
{
"id": "7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11",
"number": 482,
"title": "Call to confirm the proposal",
"description": "Ask about the payment terms",
"task_type": "call",
"status": "pending",
"priority": "high",
"is_completed": false,
"is_overdue": true,
"due_date": "2026-10-18T17:00:00.000Z",
"end_date": null,
"reminder_minutes_before": 60,
"size": null,
"estimate_hours": null,
"task_pipeline": { "id": "4a0631b8-b1cb-48c6-af5e-9df2bca56645", "name": "General" },
"contact": { "id": "c2f9d1a4-5b7e-4c1a-9e0f-3a8b6d2c4e71", "name": "John Doe", "company": "Acme Inc" },
"opportunity": { "id": "e8a3b2c1-6d4f-4a9e-b1c7-5f2d8e0a9b34", "title": "Acme Inc - Plan Pro" },
"playbook_run": {
"id": "3ef8c1c3-c081-4187-a6aa-657fbf1a813b",
"playbook_id": "9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62",
"playbook_name": "Onboarding",
"step": 2,
"total_steps": 5
},
"assignees": [
{ "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva", "email": "maria@acme.com" }
],
"labels": [
{ "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "name": "VIP", "color": "#ef4444" }
],
"recurrence": null,
"completed_at": null,
"completed_by": null,
"created_by": { "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" },
"created_at": "2026-10-14T13:05:00.000Z",
"updated_at": "2026-10-16T09:12:00.000Z"
}
],
"pagination": {
"page": 1,
"per_page": 50,
"total": 12,
"total_pages": 1,
"has_next": false,
"has_prev": false
}
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Task identifier |
number | integer | Sequential task number shown in the app (#482) |
title / description | string | What has to be done |
task_type | string | call, meeting, email, follow_up, proposal, communication, internal_task or other |
status | string | pending, in_progress, completed or cancelled (a step of a cancelled playbook run) |
priority | string | low, medium, high or urgent |
is_completed | boolean | Same as status = completed |
is_overdue | boolean | Open and past due_date |
due_date / end_date | string | UTC timestamps. end_date is set only for multi-day tasks |
reminder_minutes_before | integer | Reminder sent to the assignees 15, 60 or 1440 minutes before due_date (nullable) |
size / estimate_hours | string / number | Effort estimate (nullable) |
task_pipeline | object | Task pipeline (board) the task is in |
contact / opportunity | object | What the task is about (nullable) |
playbook_run | object | Set when the task is a step of a playbook run: which step out of how many (nullable) |
assignees | array | Users responsible for the task |
labels | array | Task labels |
recurrence | object | unit (hour, day, week), interval, end_date, remaining_count: completing the task creates the next occurrence (nullable) |
completed_at / completed_by | string / object | When and by whom it was completed (nullable) |
created_by | object | Author. Tasks created through the API are authored by the user who created the API key |
created_at / updated_at | string | UTC timestamps |
pagination | object | Pagination metadata |