Skip to main content
GET
Retorna uma lista paginada de clientes. Suporta busca por nome, código, cidade ou email.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.

Headers

string
required
API key de autenticação

Query Parameters

number
default:"1"
Número da página para paginação
number
default:"20"
Quantidade de registros por página (máximo: 100)
Termo de busca. Procura em:
  • Nome do cliente
  • Código
  • Cidade
  • Email

Response

array
Array contendo os clientes encontrados
number
Página atual
number
Limite de registros por página
number
Total de clientes no banco de dados

Paginação

Para navegar pelos resultados:
  • Use page para especificar a página desejada
  • O limit controla quantos registros por página (máximo 100)
  • O campo total indica quantos registros existem no total
Exemplo de cálculo da última página:

Busca

O parâmetro search realiza busca em múltiplos campos simultaneamente:
  • Nome: Busca parcial, não case-sensitive
  • Código: Busca parcial
  • Cidade: Busca parcial
  • Email: Busca parcial
Exemplo: ?search=paulo retornará:
  • Clientes com “Paulo” no nome
  • Clientes em “São Paulo”
  • Clientes com “paulo” no email