tasks.list
Lista atividades do CRM por dono, conclusão, responsável e atraso.
Exemplos seguros e fictícios. O domínio
example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.Parâmetros
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplo fictício |
|---|---|---|---|---|
owner_type | string | Opcional | deal (padrão), contact (contato comercial) ou lead. | "deal" |
owner_id | integer | Opcional | Obrigatório se owner_type for enviado; se apenas owner_id for enviado, owner_type=deal. | 201 |
completed | boolean | Opcional | true concluídas; false pendentes. Ausente inclui ambas. | false |
responsible_id | string (uuid) | null | Opcional | Usuário com acesso à empresa por vínculo principal ou multifilial. | "00000000-0000-4000-8000-000000000001" |
overdue | boolean | Opcional | true: somente pendentes com prazo anterior a NOW(). | true |
page | integer | Opcional | Página iniciada em 1; padrão 1. | 1 |
limit | integer | Opcional | Padrão 25; mínimo 1, máximo 100. | 25 |
Exemplos fictícios
Os exemplos documentam o formato; eles não executam nenhuma operação.
Requisição
cURL demonstrativo
curl --request POST \
'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/tasks.list' \
--header 'Content-Type: application/json' \
--data '{"owner_type":"deal","owner_id":201,"completed":false,"page":1,"limit":25}'
Corpo JSON
{
"owner_type": "deal",
"owner_id": 201,
"completed": false,
"page": 1,
"limit": 25
}Resposta HTTP 200
{
"ok": true,
"method": "tasks.list",
"result": {
"total": 1,
"tasks": [
{
"id": 401,
"owner_type": "deal",
"owner_id": 201,
"type": "todo",
"subject": "Revisar proposta",
"completed": false,
"responsible_id": null,
"deadline": "2026-09-25T10:00:00",
"responsible_name": null
}
]
}
}Erros
| HTTP | Código | Condição |
|---|---|---|
| 400 | BAD_REQUEST | Parâmetro obrigatório ausente ou valor inválido. |
| 400 | INVALID_OWNER_TYPE | owner_type fora de deal, contact, lead. |
Consulte também os erros globais e limites.
Observações
- Exemplos ilustrativos e parciais: os registros podem retornar outros campos; não representam dados reais.
- total é tamanho da página, não total global. page/limit não são devolvidos.
- Ordenação: pendentes primeiro, deadline crescente (nulos por último), criação decrescente.
- O filtro responsible_id é de igualdade; null não serve para selecionar tarefas sem responsável.