# Listar clientes

URL: https://staging.pagpolar.com/docs/referencia/clientes/list-customers

> Documento e telefone são sempre mascarados nesta API.

`GET /customers`

## Autenticação

- Token Bearer no header `Authorization` (esquema `BearerAuth`). Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer <token>". Vale 24 horas.

## Parâmetros de consulta

| Parâmetro | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `page` | inteiro | não | Número da página, começando em 1. |
| `per_page` | inteiro | não | Itens por página, de 1 a 100. |
| `email` | texto (email) | não | E-mail do cliente. E-mail completo, sem diferenciar maiúsculas de minúsculas. |
| `name` | texto | não | Nome do cliente. Busca por parte do texto, sem diferenciar maiúsculas de minúsculas. |
| `document` | texto | não | Documento do cliente. CPF com 11 dígitos ou CNPJ com 14, com ou sem pontuação. Exemplo: `123.456.789-09`. |

## Respostas

### 200 — Lista de clientes

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `data` | [lista de Cliente](/docs/referencia/entidades/cliente) | não | — |
| `meta` | objeto | não | — |
| `meta.page` | inteiro | não | Exemplo: `1`. |
| `meta.per_page` | inteiro | não | Exemplo: `25`. |
| `meta.total` | inteiro | não | Exemplo: `143`. |
| `meta.total_pages` | inteiro | não | Exemplo: `6`. |

## Erros

| Status | Descrição |
| --- | --- |
| `401` | Token ausente, inválido ou expirado, ou credencial revogada ou expirada. Chame POST /auth/token para obter um token novo. |
| `403` | IP não autorizado |
| `429` | Limite de requisições excedido |

Lista completa de códigos e como tratá-los: [Erros](/docs/guias/fundamentos/erros).