v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

Listar clientes

Retorna todos os clientes que você cadastrou com suporte a paginação.

Você pode usar essa rota para visualizar todos os seus clientes e suas informações.

Alternativa: Você também pode visualizar e gerenciar seus clientes pelo Dashboard da AbacatePay.

get/customers/list

Query parameters

afterstring

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

beforestring

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

limitinteger

Example:100

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

startDatestring date

Example:2026-01-01

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

endDatestring date

Example:2026-01-31

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

idstring

Example:cust_aebxkhDZNaMmJeKsy0AHS0FQ

Filtrar por identificador único do cliente

emailstring

Example:daniel_lima@abacatepay.com

Filtrar por e-mail do cliente

taxIdstring

Example:123.456.789-01

Filtrar por CPF ou CNPJ do cliente

Response

Lista de clientes retornada com sucesso.

successboolean

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

errorstring nullable

Example response

{
  "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
}