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. São 15 recursos, 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 planoCotas documentadas e cabeçalhos em toda resposta

Por onde começar

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

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

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

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

Recursos

Quatorze recursos de negócio ligados aos módulos do Monte seu Plano, além de /me, que descreve a sua conta. Quatro recursos aceitam escrita e dez oferecem somente leitura. O nome em português é o do produto; o identificador em inglês é o que aparece na rota, no escopo e na referência.

Leitura e escrita

Somente leitura

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çõesCotas por plano, cabeçalhos X-RateLimit-* e resposta 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 linguagem cURL, Node.js, Python, PHP e n8n — o mesmo fluxo em cada um.

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

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

Sugestões Peça um recurso ou vote no que já foi pedido.

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