Skip to main content
GET
Listar clientes
Lista os clientes cadastrados, com paginação bidirecional e filtros opcionais.

Filtros

Exemplos

Para obter um cliente específico com todos os campos (incluindo updatedAt) use GET /customers/{id}.

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Query Parameters

after
string

Cursor opaco (do campo pagination.next da resposta anterior) para buscar a página seguinte.

before
string

Cursor opaco (do campo pagination.before da resposta anterior) para buscar a página anterior.

limit
integer
default:20

Quantidade máxima de itens por página (1 a 100).

Required range: 1 <= x <= 100
id
string

Filtra por ID exato do cliente.

Example:

"cust_018f3a2b7c4d7c40a1b2"

email
string

Filtra por e-mail exato (case-insensitive).

Example:

"joao@exemplo.com"

taxId
string

Filtra por CPF/CNPJ (apenas dígitos).

Example:

"12345678900"

Response

Lista paginada de clientes.

data
object[]
required
pagination
object
required

Metadados de paginação bidirecional (usado por Checkout Transparente e Webhooks). next/before são cursores opacos — passe-os de volta em after/before para navegar.

error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true