Skip to main content
curl -X GET "https://api.chargefy.io/v1/customers?limit=20&starting_after=cus_123" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "object": "list",
  "data": [
    {
      "id": "cus_123",
      "object": "customer",
      "billing_address": null,
      "billing_name": null,
      "created_at": "2026-05-16T14:09:27Z",
      "document": "12345678901",
      "document_type": "cpf",
      "email": "nome@email.com",
      "livemode": true,
      "metadata": {
        "reference_id": "ref_456"
      },
      "name": "Cliente Exemplo",
      "phone": null,
      "updated_at": null
    }
  ],
  "has_more": true,
  "url": "/v1/customers"
}
Lista clientes vinculados à organização que está atuando, ordenados por created_at decrescente. Use starting_after/ending_before para paginar.

​
Autenticação

A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <organization_id> apontando para uma organização conectada ativa.

​
Parâmetros de query

​
limit
integer
default:"10"
Quantidade de itens por página. Entre 1 e 100.
​
starting_after
string
ID do cliente que delimita o início da próxima página (exclusivo).
​
ending_before
string
ID do cliente que delimita o fim da página anterior (exclusivo).
​
email
string
Filtro por email (case-insensitive). Use o email exato.
curl -X GET "https://api.chargefy.io/v1/customers?limit=20&starting_after=cus_123" \
  -H "Authorization: Bearer {{API_KEY}}"

​
Resposta

200 OK com o envelope canônico de listagem.
CampoTipoObservação
objectstringSempre "list"
dataarrayCada item é um objeto customer completo
has_morebooleantrue quando há próxima página
urlstringPath relativo (/v1/customers)
{
  "object": "list",
  "data": [
    {
      "id": "cus_123",
      "object": "customer",
      "billing_address": null,
      "billing_name": null,
      "created_at": "2026-05-16T14:09:27Z",
      "document": "12345678901",
      "document_type": "cpf",
      "email": "nome@email.com",
      "livemode": true,
      "metadata": {
        "reference_id": "ref_456"
      },
      "name": "Cliente Exemplo",
      "phone": null,
      "updated_at": null
    }
  ],
  "has_more": true,
  "url": "/v1/customers"
}