Skip to main content
GET
/
customers
/
list
Listar clientes
curl --request GET \
  --url https://api.abacatepay.com/v2/customers/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
      "devMode": true,
      "name": "Daniel Lima",
      "cellphone": "(11) 4002-8922",
      "email": "daniel_lima@abacatepay.com",
      "taxId": "123.456.789-01",
      "country": "BR",
      "zipCode": "01310-100",
      "metadata": {
        "source": "landing-page",
        "campaign": "black-friday-2025"
      }
    }
  ],
  "success": true,
  "error": null
}

Requer a permissão CUSTOMER:READ.

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

​
before
string

Cursor para buscar itens antes deste ponto

​
limit
integer
default:100

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

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

100

​
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.