Skip to main content
GET
Listar clientes
Retorna todos os clientes cadastrados na sua loja.
Requer a permissão CUSTOMER:READ.
Use limit, after e before para paginar e startDate/endDate (YYYY-MM-DD) para filtrar por data de criação. Consulte Paginação e filtro por data. Cada item segue o mesmo formato da resposta do Criar Cliente, incluindo id, email, name e taxId.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

after
string

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

before
string

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limit
integer
default:100

Quantidade de itens por página (1-100).

Required range: 1 <= x <= 100
Example:

100

startDate
string<date>

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

Example:

"2026-01-01"

endDate
string<date>

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

Example:

"2026-01-31"

id
string

Filtrar por identificador único do cliente

Example:

"cust_aebxkhDZNaMmJeKsy0AHS0FQ"

email
string

Filtrar por e-mail do cliente

Example:

"daniel_lima@abacatepay.com"

taxId
string

Filtrar por CPF ou CNPJ do cliente

Example:

"123.456.789-01"

Response

Lista de clientes retornada com sucesso.

data
object[]

Lista de clientes.

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true

error
string | null
Example:

null

pagination
object

Informações de paginação baseada em cursor.