Skip to main content
GET
Listar clientes

Listar Clientes

Lista clientes vinculados à empresa autenticada pela X-API-Key.

Comportamento atual

  • a coleção vem no campo data
  • a paginação retorna total, page, pages e per_page
  • o filtro search é aplicado ao nome do cliente
  • cada item inclui id, nome, email, telefone, pontos e created_at

Exemplo de resposta

Status comuns

  • 200 listagem retornada com sucesso
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 422 header ou query inválidos
  • 429 limite global da API pública excedido

Headers

X-API-Key
string
required

Chave de API

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:20
Required range: 1 <= x <= 100
search
string | null

Response

Successful Response

data
PublicClientResponse · object[]
required
page
integer
required
pages
integer
required
per_page
integer
required
total
integer
required