Listar clientes
A rota de listagem de clientes permite recuperar todos os clientes cadastrados no sistema, com suporte a paginação, filtros e ordenação.
É ideal para construir telas de consulta, dashboards administrativos e buscas dinâmicas.
Autenticação
Esta rota exige autenticação via Api Key.
cURL da chamadacurl -X GET https://api.onnixpay.com/api/v1/sdk/customers \
-H "X-API-Key: ox_your_key" \
Query Parameters
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | number | Número máximo de registros por página (default: 50 ou 20, max: 100) | |
page | number | Número da página atual (iniciando em 1) | |
search | string | Filtro por nome, e-mail ou documento | |
sortBy | string | Campo usado para ordenar (ex: name, createdAt) | |
sortOrder | string | Direção da ordenação: asc ou desc | |
status | string | Filtrar clientes por status (ex: ACTIVE, INACTIVE) |