Listar clientes
Documento e telefone são sempre mascarados nesta API.
Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.
AuthorizationBearer <token>
Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.
In: header
Query Parameters
page?integer
Número da página, começando em 1.
Default
1Range
1 <= valueper_page?integer
Itens por página, de 1 a 100.
Default
25Range
1 <= value <= 100email?string
E-mail do cliente. E-mail completo, sem diferenciar maiúsculas de minúsculas.
Format
emailname?string
Nome do cliente. Busca por parte do texto, sem diferenciar maiúsculas de minúsculas.
Length
1 <= length <= 255document?string
Documento do cliente. CPF com 11 dígitos ou CNPJ com 14, com ou sem pontuação.
Response Body
curl -X GET "https://pagpolar-api.creativecode.dev.br/v1/customers?page=1&per_page=25&email=user%40example.com&name=string&document=123.456.789-09"{
"data": [
{
"id": "e6f7a8b9-c0d1-4e2f-3a4b-5c6d7e8f9a0b",
"name": "Maria Souza",
"email": "maria@exemplo.com",
"document": "***.456.***-**",
"phone": "****4321",
"is_active": true,
"created_at": "2026-01-05T08:00:00.000Z"
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 143,
"total_pages": 6
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}