Ir para o conteúdo da documentação

Comece a usar a API REST do Lesto

Integre sistemas, bots e automações ao seu workspace. Consulte e atualize projetos, etapas, entregas, comentários e checklists via requisições HTTP.

O que é possível fazer

  • Consultar e criar Projetos.
  • Consultar, criar, editar, arquivar, restaurar e reordenar Etapas.
  • Consultar, criar, mover, concluir, arquivar, restaurar e reordenar Entregas.
  • Localizar membros do workspace para atribuir responsáveis.
  • Criar, consultar, editar e excluir logicamente Comentários.
  • Criar, organizar e excluir Checklists e Itens.

Conceitos básicos

API
Forma de um sistema se comunicar com outro por regras conhecidas.
Endpoint
Endereço usado para executar uma operação, como listar Projetos.
Token
Credencial secreta usada para autenticar a integração.
Scope
Permissão concedida ao token para ler ou escrever um tipo de recurso.
Request
A requisição enviada pelo seu sistema para a API.
Response
A resposta JSON devolvida pela API.
JSON
Formato de dados usado nas respostas e nos corpos de algumas requisições.
ID
Identificador único de um recurso. Trate IDs como strings opacas.

Criar um token

No Lesto, acesse Configurações → Integrações → API pública.

Somente administradores podem criar tokens. Ao criar, escolha um nome, selecione os scopes necessários e defina a expiração. O token completo aparece apenas uma vez.

Trate o token como segredo

Guarde o token em variável de ambiente ou cofre de segredos. Não use em frontend público, não envie pela URL e não salve no Git.

Scopes necessários

Scopes são permissões concedidas ao token. Para este tutorial, selecione apenas:

  • projects:read — Permite listar Projetos e consultar um Projeto.
  • stages:read — Permite listar as Etapas de um Projeto.

Permissões de escrita não incluem leitura automaticamente. A lista completa de scopes está na referência técnica.

Prefixo da API

Todos os endpoints usam o domínio do workspace seguido de /api/v1.

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

Combine o prefixo com um recurso, como:

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

Autenticação

Todas as requisições exigem o header Authorization com o token no formato Bearer:

HTTP
Authorization: Bearer YOUR_API_TOKEN

Respostas 401 normalmente indicam token ausente, inválido, expirado ou revogado.

Faça sua primeira requisição

GET/projects(scope: projects:read)
BASH
curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Entenda a resposta

JSON
{
  "data": [
    {
      "id": "prj_123",
      "workspaceId": "wsp_456",
      "name": "Integração CRM",
      "description": "Projeto importado via API",
      "status": "active",
      "createdAt": "2026-08-01T12:00:00.000Z",
      "updatedAt": "2026-08-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "requestId": "req_789",
    "limit": 50,
    "nextCursor": null,
    "hasMore": false
  }
}
  • data contém a lista de Projetos.
  • id identifica o Projeto (ex: prj_123).
  • meta traz informações de paginação.

Use o ID retornado

Substitua PROJECT_ID pelo id retornado na primeira chamada:

GET/projects/{projectId}/stages(scope: stages:read)
BASH
curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects/prj_123/stages" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
JSON
{
  "data": [
    {
      "id": "stg_001",
      "projectId": "prj_123",
      "name": "Em andamento",
      "color": "#3B82F6",
      "position": 1,
      "isArchived": false,
      "createdAt": "2026-08-01T12:00:00.000Z",
      "updatedAt": "2026-08-01T12:00:00.000Z"
    }
  ]
}

Fluxo visual

  1. Criar token em Configurações → Integrações
  2. Listar Projetos (GET /projects)
  3. Selecionar o projectId desejado
  4. Listar Etapas (GET /projects/{id}/stages)
  5. Continuar a integração com os recursos específicos

Recursos disponíveis

Projetos
Crie e atualize a estrutura principal do trabalho.
Etapas
Organize o fluxo visual de um Projeto.
Membros
Encontre IDs de membros para atribuir responsáveis.
Entregas
Crie, mova, conclua, arquive e restaure trabalhos.
Comentários
Registre contexto e acompanhe conversas em Entregas.
Checklists
Organize critérios, subtarefas e itens de aceite.

Consulte os detalhes de cada recurso na referência técnica da API.

Próximos passos

Acesse a Referência Completa para consultar endpoints de criação de Projetos, Etapas, Entregas, Comentários, Checklists, além dos detalhes sobre paginação, idempotência e tratamento de erros.