Skip to main content
GET
Listar clientes

Cabeçalhos

X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Parâmetros de consulta

page
integer
padrão:1

Número da página

Intervalo obrigatório: x >= 1
limit
integer
padrão:20

Itens por página

Intervalo obrigatório: 1 <= x <= 100

Buscar por nome, e-mail ou documento

Exemplo:

"joao"

Resposta

Lista de clientes

items
object[]
obrigatório

Lista de clientes

total
integer
obrigatório

Número total de clientes

Exemplo:

100

page
integer
obrigatório

Página atual

Exemplo:

1

limit
integer
obrigatório

Itens por página

Exemplo:

20

totalPages
integer
obrigatório

Número total de páginas

Exemplo:

5