Pular para o conteúdo principal

Tarefas

Corresponde à tela Tarefas. Organiza as atividades da equipe comercial, como ligar para um cliente, enviar uma proposta ou retornar um contato. Cada tarefa tem assunto, prazo, prioridade, situação, responsável e, se preciso, um lembrete. As tarefas criadas a partir de um lead de empresa também aparecem nesta lista; veja Tarefas do lead de empresa.

Endpoints​

MétodoCaminhoDescrição
GET/crm/tasksLista as tarefas
POST/crm/tasksCria uma tarefa
GET/crm/tasks/{uuid}Consulta uma tarefa
PUT/crm/tasks/{uuid}Altera uma tarefa
DELETE/crm/tasks/{uuid}Apaga uma tarefa
PATCH/crm/tasks/{uuid}/completeMarca a tarefa como concluída
GET/crm/tasks/prioritiesLista as prioridades (apoio)
GET/crm/tasks/statusesLista as situações (apoio)
GET/crm/tasks/usersLista os usuários responsáveis (apoio)

GET /crm/tasks​

Lista as tarefas da empresa cliente.

Parâmetros de URL

ParâmetroDescrição
priority_idId da prioridade
status_idId da situação
start_due_dateData inicial vencimento (AAAA-MM-DD)
end_due_dateData final de vencimento (AAAA-MM-DD)
start_reminderData inicial do lembrete (AAAA-MM-DD)
end_reminderData final do lembrete (AAAA-MM-DD)
per_page, pagePaginação, conforme Convenções

Exemplo

curl "https://api.pedagogo.app/crm/tasks?status_id=1&per_page=15&page=1" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"

Resposta (200): a lista de tarefas, sem per_page, ou a página de tarefas, com per_page. Cada tarefa traz o assunto, o vencimento, o lembrete, o responsável, a situação, a prioridade e os nomes de quem criou e de quem alterou.

POST /crm/tasks​

Cria uma tarefa.

Corpo

CampoObrigatórioTipoDescrição
subjectSimtextoAssunto da tarefa
priority_idNãointeiroPrioridade da tarefa
status_idNãointeiroSituação da tarefa
user_idNãointeiroResponsável pela tarefa. Sem ele, a tarefa fica com o usuário que a criou
due_dateNãodataData de vencimento
reminder_datetimeNãodata e horaLembrete. Não pode ser posterior à data de vencimento. Se for uma data e hora futura, o aviso ao responsável é agendado para esse horário
descriptionNãotextoDescrição da tarefa

Exemplo

curl -X POST https://api.pedagogo.app/crm/tasks \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"subject": "Retornar ligação",
"due_date": "2026-11-20",
"reminder_datetime": "2026-11-19 09:00:00"
}'

Resposta (201): a tarefa criada, com o uuid.

GET /crm/tasks/{uuid}​

Consulta uma tarefa. Resposta (200): a tarefa, com a prioridade e a situação.

PUT /crm/tasks/{uuid}​

Altera uma tarefa. Envie apenas os campos que mudam.

Corpo

CampoObrigatórioTipoDescrição
subjectNãotextoAssunto da tarefa
priority_idNãointeiroPrioridade da tarefa
status_idNãointeiroSituação da tarefa
user_idNãointeiroResponsável pela tarefa
due_dateNãodataData de vencimento
reminder_datetimeNãodata e horaLembrete. Não pode ser posterior à data de vencimento
descriptionNãotextoDescrição da tarefa

Resposta (200): a tarefa alterada.

DELETE /crm/tasks/{uuid}​

Remove a tarefa. Se a tarefa estiver vinculada a um lead de empresa, o vínculo também é removido. Resposta (200).

PATCH /crm/tasks/{uuid}/complete​

Marca a tarefa como concluída. Não há corpo. Resposta (200): a tarefa, com a situação Concluída.

GET /crm/tasks/priorities​

Lista as prioridades de tarefa, para o campo priority_id. Resposta (200): a lista de prioridades.

GET /crm/tasks/statuses​

Lista as situações de tarefa, para o campo status_id. Resposta (200): a lista de situações.

GET /crm/tasks/users​

Lista os usuários da empresa, para o campo user_id. Resposta (200): a lista de usuários.