Referência da API REST do Lesto

Prefixo da API

Todos os endpoints usam o domínio do workspace e o prefixo /api/v1.

https://SEU_WORKSPACE.workspace.lesto.app/api/v1

Autenticação

Envie o token no header Authorization. Tokens devem ser usados em backend ou servidor, nunca em frontend público.

Authorization: Bearer YOUR_API_TOKEN

Scopes

Scopes são definidos na criação do token. Permissões de escrita não incluem leitura automaticamente; selecione o menor conjunto necessário para a integração.

Projects

Projetos são o contêiner principal do trabalho e agrupam Etapas e Entregas.

curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

curl -X POST "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: project-create-001" \
  -d '{"name":"Implantação do cliente"}'

Stages

Etapas pertencem a um Projeto, aparecem no fluxo visual e podem ser arquivadas, restauradas e reordenadas.

curl -X POST "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects/PROJECT_ID/stages" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: stage-create-001" \
  -d '{"title":"A fazer"}'

curl -X PATCH "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects/PROJECT_ID/stages/reorder" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: stages-reorder-001" \
  -d '{"orderedIds":["STAGE_ID","STAGE_ID_2","STAGE_ID_3"]}'

Workspace Members

Membros ativos do workspace podem ser consultados para obter IDs usados em assigneeIds.

curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/workspace/members?search=Ana" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Deliveries

Entregas representam trabalhos dentro de uma Etapa e aceitam responsáveis, status, prioridade e datas.

curl -X POST "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects/PROJECT_ID/deliveries" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: delivery-create-001" \
  -d '{"title":"Preparar proposta","stageId":"STAGE_ID","assigneeIds":["MEMBER_ID"]}'

Comments

Comentários adicionam contexto a Entregas; comentários importados são somente leitura.

curl -X POST "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/deliveries/DELIVERY_ID/comments" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: comment-create-001" \
  -d '{"content":"Atualização registrada pela integração."}'

Checklists

Checklists organizam critérios e subtarefas de uma Entrega. A listagem atual não é paginada.

curl -X POST "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/deliveries/DELIVERY_ID/checklists" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: checklist-create-001" \
  -d '{"title":"Critérios de aceite"}'

Checklist Items

Itens ficam dentro de Checklists, podem ser concluídos ou reabertos e não possuem movimentação pública entre Checklists.

Reordenação

Operações de reorder usam sempre a lista final completa de recursos ativos, cada ID exatamente uma vez. Recursos arquivados ou excluídos ficam fora da lista. Uma lista desatualizada retorna 409.

{
  "orderedIds": ["ID_1", "ID_2", "ID_3"]
}

Archive e restore

Conclusão altera o estado do trabalho. Archive oculta o recurso das consultas comuns sem apagar os dados. Restore volta a disponibilizar o recurso. Soft delete remove das consultas públicas e preserva o registro.

Paginação

Listagens paginadas aceitam limit e cursor. O limit padrão é 50, o máximo é 100, e cursor é opaco. A resposta inclui meta.nextCursor e meta.hasMore para a próxima chamada.

curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects?limit=50&cursor=NEXT_CURSOR" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Idempotência

Repita a mesma operação com a mesma chave quando precisar retentar com segurança. Uma nova operação deve usar uma nova chave. A mesma chave com o mesmo payload retorna o header Idempotency-Replayed: true; com conteúdo diferente, retorna 409. Use chaves de 1 a 128 caracteres.

Rate limit

Quando o limite é excedido, a API retorna 429. Use Retry-After para aguardar antes de tentar novamente.

Erros

Respostas de erro usam envelope com requestId. Guarde esse valor ao acionar suporte.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Revise os campos enviados.",
    "requestId": "REQUEST_ID"
  }
}

Recursos ainda não disponíveis

• Sem delete físico de Projects.
• Sem duplicação pública.
• Sem movimentação pública de Item entre Checklists.
• Sem webhooks.
• Sem OAuth.
• Sem SDK oficial.
• Sem uso documentado direto no navegador.
• Comments importados são somente leitura.

Referência rápida

← Voltar para o guia introdutório