Pular para o conteúdo principal
GET
/
customers
Listar clientes
curl --request GET \
  --url https://api.pague.dev/v1/customers \
  --header 'X-API-Key: <x-api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "João da Silva",
      "email": "[email protected]",
      "documentType": "cpf",
      "document": "***456789**",
      "createdAt": "2023-11-07T05:31:56Z",
      "phone": "+5511999998888"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 20,
  "totalPages": 5
}

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