openthorDocumentação
Abrir o painel

GET /v1/customers

Cadastro de clientes. · domínio Clientes

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/customers?limit=5"

A autenticação e o formato do envelope { data, meta } são comuns a todos os endpoints — veja Autenticação e Resposta e metadados.

Filtros e período

Campos filtráveis com a sintaxe campo=op:valor:

  • customer_code — numérico (eq · in · gte · lte · gt · lt)
  • rep_code — numérico (eq · in · gte · lte · gt · lt)
  • network_code — numérico (eq · in · gte · lte · gt · lt)
  • activity_code — numérico (eq · in · gte · lte · gt · lt)
  • municipality_code — numérico (eq · in · gte · lte · gt · lt)

Sem janela de datas — este endpoint é um retrato do momento (from/to não se aplicam).

Colunas retornadas

  • customer_code — Cliente (cód.)
  • name — Nome
  • trade_name — Nome fantasia
  • tax_id — CNPJ/CPF
  • municipality_name — Município
  • state — UF
  • rep_code — Vendedor (RCA)
  • is_blocked — Bloqueado

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: customer_code · name · credit_limit · registered_at. Limite padrão 100, máximo 1000 linhas por chamada; pagine com offset enquanto meta.has_more for true.

O que sua chave enxerga

O recorte da credencial (filial, vendedor, cliente, fornecedor, janela de datas) é aplicado no servidor e não pode ser ampliado por filtros — dois usuários podem ver totais diferentes no mesmo endpoint, por desenho.

Ferramentas MCP sobre este endpoint