GET /api/v1/buyers/

Retorna uma lista paginada de compradores da organização

Lista todos os compradores que realizaram transações na organização autenticada. Os compradores são filtrados automaticamente pelo contexto da organização do token — nunca é necessário passar organization_id como parâmetro.

​

Autenticação

Requer Organization Access Token (OAT) via header Authorization: Bearer.

Escopos necessários: web:read, web:write ou buyers:read.

​

Parâmetros de Query

email · string

Filtrar por e-mail (busca parcial, sem diferença de maiúsculas/minúsculas)

page · integer · default: "1"

Número da página

limit · integer · default: "20"

Itens por página

​

Resposta

items · array

Lista de objetos de comprador

Show Propriedades do comprador

id · string

ID interno do comprador

email · string

E-mail do comprador

first_name · string

Nome

last_name · string

Sobrenome

taxpayer_id · string

CPF do comprador

phone · string

Telefone

zoop_buyer_id · string

ID do comprador no gateway de pagamentos (campo da API)

created_at · string

Data de criação (ISO 8601)

pagination · object

Show Propriedades

total_count · integer

Total de itens

max_page · integer

Número máximo de páginas

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/buyers/?page=1&limit=20" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "items": [
    {
      "id": "b1a2c3d4e5f6",
      "email": "[e-mail]",
      "first_name": "João",
      "last_name": "Silva",
      "taxpayer_id": "12345678901",
      "phone": "11999990000",
      "zoop_buyer_id": "gw_buyer_abc123",
      "created_at": "2026-03-01T10:00:00Z"
    }
  ],
  "pagination": {
    "total_count": 150,
    "max_page": 8
  }
}