Listar Tarefas
GET/external/v1/tasksRetorna uma lista paginada de tarefas: afazeres com prazo, um tipo e um ou mais responsáveis. Uma tarefa pode pertencer a uma oportunidade, a um contato, a uma execução de playbook (uma tarefa por etapa) ou existir sozinha como tarefa da equipe.
Autenticação
Requer permissão tasks:read.
O que a chave enxerga
Uma chave enxerga as mesmas tarefas que o usuário que criou a chave enxerga no app. Administradores e supervisores veem todas as tarefas da conta. Os demais usuários veem as tarefas das oportunidades das quais são responsáveis, mais as tarefas atribuídas a eles.
Parâmetros de Consulta
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | integer | 1 | Número da página |
limit | integer | 50 | Itens por página (1-100) |
status | string | - | Separados por vírgula: pending, in_progress, completed, cancelled. Sem ele, todos os status exceto cancelled |
assignee_id | string | - | Apenas tarefas atribuídas a este usuário (veja Listar Usuários) |
contact_id | string | - | Apenas tarefas deste contato (diretamente ou pela oportunidade dele) |
opportunity_id | string | - | Apenas tarefas desta oportunidade |
playbook_run_id | string | - | Apenas as etapas desta execução de playbook |
task_pipeline_id | string | - | Apenas tarefas deste pipeline de tarefas (veja Pipelines e Etiquetas de Tarefa) |
task_type | string | - | Separados por vírgula: call, meeting, email, follow_up, proposal, communication, internal_task, other |
priority | string | - | Separados por vírgula: low, medium, high, urgent |
overdue | boolean | - | true = apenas tarefas abertas com o prazo vencido |
search | string | - | Correspondência parcial no título, ou o número da tarefa (#123) |
due_after / due_before | string (ISO 8601) | - | Intervalo de prazo |
created_after / created_before | string (ISO 8601) | - | Intervalo de criação |
updated_after / updated_before | string (ISO 8601) | - | Intervalo da última atualização (sync incremental) |
sort_by | string | due_date | due_date, created_at ou updated_at. Tarefas sem prazo vêm por último |
sort_order | string | asc para due_date, desc nos demais | asc ou desc |
Fila do dia de um vendedor
GET /tasks?assignee_id=USER_ID&status=pending,in_progress&due_before=2026-10-19T23:59:59-03:00
Um status, task_type ou priority desconhecido, um id que não é UUID ou uma data inválida retorna 400 VALIDATION_ERROR.
Requisição
curl --request GET \
--url "https://app.getraze.com/external/v1/tasks?status=pending,in_progress&overdue=true" \
--header "X-API-Key: YOUR_API_KEY"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);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())Resposta
{
"success": true,
"data": [
{
"id": "7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11",
"number": 482,
"title": "Ligar para confirmar a proposta",
"description": "Perguntar sobre as condições de pagamento",
"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": "Geral" },
"contact": { "id": "c2f9d1a4-5b7e-4c1a-9e0f-3a8b6d2c4e71", "name": "John Doe", "company": "Acme Inc" },
"opportunity": { "id": "e8a3b2c1-6d4f-4a9e-b1c7-5f2d8e0a9b34", "title": "Acme Inc - Plano 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
}
}Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da tarefa |
number | integer | Número sequencial da tarefa exibido no app (#482) |
title / description | string | O que precisa ser feito |
task_type | string | call, meeting, email, follow_up, proposal, communication, internal_task ou other |
status | string | pending, in_progress, completed ou cancelled (uma etapa de uma execução de playbook cancelada) |
priority | string | low, medium, high ou urgent |
is_completed | boolean | Equivale a status = completed |
is_overdue | boolean | Aberta e com due_date vencido |
due_date / end_date | string | Timestamps em UTC. end_date só é preenchido em tarefas de vários dias |
reminder_minutes_before | integer | Lembrete enviado aos responsáveis 15, 60 ou 1440 minutos antes de due_date (nullable) |
size / estimate_hours | string / number | Estimativa de esforço (nullable) |
task_pipeline | object | Pipeline de tarefas (quadro) em que a tarefa está |
contact / opportunity | object | Do que trata a tarefa (nullable) |
playbook_run | object | Preenchido quando a tarefa é uma etapa de uma execução de playbook: qual etapa, de quantas (nullable) |
assignees | array | Usuários responsáveis pela tarefa |
labels | array | Etiquetas de tarefa |
recurrence | object | unit (hour, day, week), interval, end_date, remaining_count: concluir a tarefa cria a próxima ocorrência (nullable) |
completed_at / completed_by | string / object | Quando e por quem foi concluída (nullable) |
created_by | object | Autor. Tarefas criadas pela API têm como autor o usuário que criou a chave |
created_at / updated_at | string | Timestamps em UTC |
pagination | object | Metadados de paginação |