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

{
  "object": "list",
  "data": [
    {
      "id": "file_123",
      "object": "file",
      "created_at": "2026-05-24T10:14:50Z",
      "filename": "foto.webp",
      "livemode": true,
      "metadata": {},
      "mime_type": "image/webp",
      "purpose": "product_image",
      "size": 184320,
      "updated_at": null,
      "url": "https://storage.chargefy.io/file_123"
    }
  ],
  "has_more": false,
  "url": "/v1/files"
}
Lista arquivos vinculados à organização que está atuando, ordenados por created_at decrescente. Use starting_after/ending_before para paginar. Cada item vem no mesmo shape de GET /v1/files/:id.

​
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 arquivo que delimita o início da próxima página (exclusivo).
​
ending_before
string
ID do arquivo que delimita o fim da página anterior (exclusivo).
​
purpose
string
Filtra por purpose: organization_avatar, product_image ou dispute_evidence.
curl -X GET "https://api.chargefy.io/v1/files?purpose=product_image&limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

​
Resposta

200 OK com o envelope canônico de listagem.
CampoTipoObservação
objectstringSempre "list"
dataarrayCada item é um objeto file completo
has_morebooleantrue quando há próxima página
urlstringPath relativo (/v1/files)
{
  "object": "list",
  "data": [
    {
      "id": "file_123",
      "object": "file",
      "created_at": "2026-05-24T10:14:50Z",
      "filename": "foto.webp",
      "livemode": true,
      "metadata": {},
      "mime_type": "image/webp",
      "purpose": "product_image",
      "size": 184320,
      "updated_at": null,
      "url": "https://storage.chargefy.io/file_123"
    }
  ],
  "has_more": false,
  "url": "/v1/files"
}

​
Erros comuns

StatuscodeQuando ocorre
400invalid_requestpurpose enviado fora do conjunto suportado