Skip to main content
Endpoints de listagem retornam um envelope de lista e usam paginação por cursor. Use limit, starting_after e ending_before para navegar pelos resultados.
curl "https://api.chargefy.io/v1/customers?limit=20&starting_after=cus_123" \
  -H "Authorization: Bearer {{API_KEY}}"

Parâmetros

limit
integer
Quantidade máxima de itens retornados.
starting_after
string
Cursor para buscar itens depois do objeto informado.
ending_before
string
Cursor para buscar itens antes do objeto informado.

Resposta

Listagens sempre retornam object: "list", a url relativa do endpoint, has_more e o array data.
{
  "object": "list",
  "data": [
    {
      "id": "cus_123",
      "object": "customer",
      "email": "cliente@example.com"
    }
  ],
  "has_more": true,
  "url": "/v1/customers"
}
object
string
Sempre list.
data
array
Lista de objetos públicos do recurso consultado.
has_more
boolean
true quando existe uma próxima página.
url
string
URL relativa do endpoint listado.

Filtros

Filtros variam por recurso e são documentados na página de cada endpoint. Quando um endpoint aceita filtros de intervalo, use operadores como [gte], [gt], [lte] e [lt]. Exemplo:
GET /v1/payment-intents?created_at[gte]=2026-05-01T00:00:00Z