GET /v1/customers 200 OK

{
  "data": [
    { "id": "9b2f…", "full_name": "Maria Souza" },
    { "id": "c47a…", "full_name": "João Pires" }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6…"
  }
}

request_id: req_01HX… application/json

API v1 · REST · OpenAPI 3.1 Construa com a Ligga API

A API pública da Ligga expõe os dados da sua conta por HTTP. Use autenticação por chave, paginação por cursor e erros no formato RFC 7807.

Início rápido Referência dos endpoints

OpenAPI 3.1Especificação aberta, para gerar clientes e tipos Erros RFC 7807Corpo de erro estruturado, com type estável Paginação por cursorListagens estáveis mesmo com dados mudando Limites por planoLimites efetivos na equipe e Retry-After no erro 429

Por onde começar

Primeiros passosAutentique uma chave e faça a primeira chamada validada em GET /v1/me.

AutenticaçãoFormato das chaves, escopos por recurso e restrição por IP.

Módulos e escoposQuais recursos a sua conta acessa, de acordo com o plano contratado.

Referência dos endpointsTodos os endpoints com schema, exemplos e execução no navegador.

Recursos

Os recursos estão organizados pelas áreas da Ligga. Equipe e limites mostra a oferta de API, os módulos e os escopos da chave. As páginas de cada recurso informam quais operações estão disponíveis.

Cadastros

Catálogo

Financeiro

Agenda

Convenções que valem para todos os recursos

Estas regras não mudam de endpoint para endpoint. Leia uma vez e vale para o resto da API.

Paginação, filtros e ordenaçãoCursor em pagination.next_cursor, filtros por campo e operador.IdempotênciaRepita uma escrita com a mesma Idempotency-Key sem duplicar o registro.ErrosFormato RFC 7807, com type estável e request_id para suporte.Limites de requisiçõesLimites na equipe e espera indicada por Retry-After ao receber 429.Formatos de identificadorQuais formatos de id a API aceita e devolve.Modo testeO que as chaves ligga_test_ fazem hoje e o isolamento planejado.

Exemplos e receitas

Exemplos por linguagemcURL, Node.js, Python, PHP e n8n — o mesmo fluxo em cada um.

ReceitasImportar clientes de um CSV, criar venda com itens, sincronizar com n8n.

ChangelogO que mudou em cada versão da API e da documentação.

Veja também

Início rápido — a primeira chamada, passo a passo
Autenticação — formato das chaves e escopos
Sua conta (me) — a chamada que confirma se a chave funciona
Referência dos endpoints — o contrato completo, endpoint a endpoint