ABabacatepay

Listar clientes

Changed on

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

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/customers/list
  • Auth
    HTTP bearer

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:11144477735

Filtrar por CPF ou CNPJ do cliente

namestring
Example:Daniel Lima

Filtrar por nome do cliente

cellphonestring
Example:(11) 4002-8922

Filtrar por telefone 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": "11144477735",
      "country": "BR",
      "zipCode": "01310-100",
      "address": {
        "zipCode": "01310-100",
        "street": "Avenida Paulista",
        "number": "1000",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "complement": "Sala 12"
      },
      "metadata": {
        "source": "landing-page",
        "campaign": "black-friday-2025"
      }
    }
  ],
  "success": true
}

Changes

  • 319122d4f5fcRevision changes
    • info

      added the optional property // to the response with the status

  • ea8a72b04f2aRevision changes
    • info

      added the new optional query request parameter cellphone

    • info

      added the new optional query request parameter name