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.
https://SEU_WORKSPACE.workspace.lesto.app/api/v1
Combine o prefixo com um recurso, como:
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:
Authorization: Bearer YOUR_API_TOKEN
Respostas 401 normalmente indicam token ausente, inválido, expirado ou revogado.
Faça sua primeira requisição
/projects(scope: projects:read)curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Entenda a resposta
{
"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
}
}
datacontém a lista de Projetos.ididentifica o Projeto (ex:prj_123).metatraz informações de paginação.
Use o ID retornado
Substitua PROJECT_ID pelo id retornado na primeira chamada:
/projects/{projectId}/stages(scope: stages:read)curl "https://SEU_WORKSPACE.workspace.lesto.app/api/v1/projects/prj_123/stages" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"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
- Criar token em Configurações → Integrações
- Listar Projetos (
GET /projects) - Selecionar o
projectIddesejado - Listar Etapas (
GET /projects/{id}/stages) - 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.