API

Tarefas

Gerencie tarefas de projetos e seus fluxos de trabalho pela API.

Tarefas

Tarefas pertencem a um projeto e podem ser organizadas em colunas de um pipeline. A API usa assignee_ids como formato preferido para responsáveis e mantém assignee_id por compatibilidade.

GET /tasks

Lista somente tarefas cujo deleted_at é null no time autenticado.

Parâmetros de consulta

ParâmetroTipoPadrãoDescrição
pagenumber1Página atual.
limitnumber20Itens por página, até 100.
project_iduuidFiltra pelo projeto.
pipeline_iduuidFiltra pelo pipeline.
assignee_iduuidFiltra tarefas que contêm o responsável em assignee_ids.
prioritystringurgent, high, medium, low ou none.
columnstringFiltra pelo slug da coluna.
searchstringBusca em title e description.
sortstring-created_atCampo de ordenação; use - para ordem decrescente.

Os campos aceitos em sort são title, priority, due_date, position, created_at, updated_at e completed_at.

curl -X GET "https://app.usecolmeia.com/api/v1/tasks?project_id=660e8400-e29b-41d4-a716-446655440002&priority=high" \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Resposta

{
  "success": true,
  "data": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440003",
      "title": "Validar briefing de implantação",
      "description": "Confirmar os requisitos antes do início.",
      "project_id": "660e8400-e29b-41d4-a716-446655440002",
      "pipeline_id": "990e8400-e29b-41d4-a716-446655440005",
      "column": "em-andamento",
      "priority": "high",
      "assignee_id": "880e8400-e29b-41d4-a716-446655440004",
      "assignee_ids": ["880e8400-e29b-41d4-a716-446655440004"],
      "reporter_id": null,
      "due_date": "2026-08-20",
      "estimated_hours": 2.5,
      "actual_hours": null,
      "position": 1,
      "tags": ["implantacao"],
      "checklist_markdown": null,
      "completed_at": null,
      "created_at": "2026-08-11T10:30:00Z",
      "updated_at": "2026-08-11T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "pages": 1
  }
}

POST /tasks

Cria uma tarefa. title e project_id são obrigatórios. Quando pipeline_id é omitido, a API usa o pipeline padrão do projeto; quando a coluna é omitida, usa a primeira coluna desse pipeline. Se não houver coluna resolvida, usa backlog.

CampoTipoObrigatórioDescrição
titlestringSimTítulo da tarefa.
project_iduuidSimProjeto ao qual a tarefa pertence.
descriptionstringNãoDetalhes da tarefa.
pipeline_iduuidNãoPipeline da tarefa.
column ou column_slugstringNãoSlug da coluna.
prioritystringNãourgent, high, medium, low ou none. O padrão é none.
assignee_idsuuid[]NãoLista de responsáveis; formato preferido.
assignee_iduuidNãoResponsável único para compatibilidade.
reporter_iduuidNãoPessoa que reportou a tarefa.
due_datedateNãoData no formato YYYY-MM-DD.
estimated_hoursnumberNãoEstimativa em horas.
tagsstring[]NãoTags da tarefa.
checklist_markdownstringNãoChecklist em Markdown.
curl -X POST https://app.usecolmeia.com/api/v1/tasks \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "660e8400-e29b-41d4-a716-446655440002",
    "title": "Validar briefing de implantação",
    "priority": "high",
    "assignee_ids": ["880e8400-e29b-41d4-a716-446655440004"],
    "estimated_hours": 2.5
  }'

A criação retorna 201. Se o projeto não pertencer ao time autenticado, retorna 404 NOT_FOUND.

GET /tasks/:id

Retorna uma tarefa ativa do time autenticado. Tarefas excluídas logicamente retornam 404.

curl -X GET https://app.usecolmeia.com/api/v1/tasks/770e8400-e29b-41d4-a716-446655440003 \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

PUT /tasks/:id

Atualiza uma tarefa ativa. project_id não é atualizável. Envie ao menos um dos campos aceitos.

Campo atualizávelTipo
titlestring
description, checklist_markdownstring ou null
due_date, completed_atdata ou data/hora ISO 8601, conforme o campo
pipeline_iduuid ou null
column ou column_slugstring
priorityurgent, high, medium, low ou none
assignee_idsuuid[]; atualiza também assignee_id com o primeiro valor
assignee_iduuid ou null; mantido por compatibilidade
reporter_iduuid ou null
estimated_hours, actual_hoursnumber ou null
positionnumber
tagsstring[]
curl -X PUT https://app.usecolmeia.com/api/v1/tasks/770e8400-e29b-41d4-a716-446655440003 \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "column": "concluido",
    "completed_at": "2026-08-20T15:00:00Z",
    "actual_hours": 2
  }'

DELETE /tasks/:id

Exclui logicamente uma tarefa ativa ao preencher deleted_at. A tarefa deixa de aparecer em GET /tasks e em GET /tasks/:id.

curl -X DELETE https://app.usecolmeia.com/api/v1/tasks/770e8400-e29b-41d4-a716-446655440003 \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Resposta

{
  "success": true,
  "data": {
    "id": "770e8400-e29b-41d4-a716-446655440003",
    "deleted_at": "2026-08-20T16:00:00Z"
  }
}

A API não oferece restauração de tarefas excluídas. Use o painel para restaurá-las, quando disponível para o seu fluxo.

Erros comuns

StatusCódigoCausa
400VALIDATION_ERRORCorpo inválido, title ou project_id ausente, prioridade inválida ou nenhum campo para atualizar.
404NOT_FOUNDProjeto ou tarefa não encontrado no time, ou tarefa já excluída.