Listar arquivos

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

{
  "object": "list",
  "data": [
    {
      "id": "file_7TWEdpzCfXHWA52K",
      "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_7TWEdpzCfXHWA52K"
    }
  ],
  "has_more": false,
  "url": "/v1/files"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid purpose filter",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

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 sua organização atua diretamente nela. Não envie o header Organization nesse caso.

Com Chargefy for Platforms, envie também Organization: org_... para listar arquivos de uma organização filha ativa da plataforma.

Parâmetros de query

integer

default:"10"

Quantidade de itens por página. Entre 1 e 100.

string

ID do arquivo que delimita o início da próxima página (exclusivo).

string

ID do arquivo que delimita o fim da página anterior (exclusivo).

string

Filtra pelo purpose do arquivo.

Valor	Descrição
`organization_avatar`	Logo ou avatar da organização.
`user_avatar`	Avatar de usuário gerenciado pelo dashboard.
`product_image`	Imagem de produto.
`platform_avatar`	Logo de plataforma gerenciado pelo dashboard.
`dispute_evidence`	Evidência anexada a uma disputa.
`kyc_document`	Foto ou PDF privado de verificação de identidade.

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

Resposta

200 OK com o payload canônico de listagem.

Campo	Tipo	Observação
`object`	`string`	Sempre `"list"`
`data`	`array`	Cada item é um objeto `file` completo
`has_more`	`boolean`	`true` quando há próxima página
`url`	`string`	Path relativo (`/v1/files`)

{
  "object": "list",
  "data": [
    {
      "id": "file_7TWEdpzCfXHWA52K",
      "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_7TWEdpzCfXHWA52K"
    }
  ],
  "has_more": false,
  "url": "/v1/files"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid purpose filter",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Erros comuns

Status	`code`	Quando ocorre
`400`	`invalid_request`	`purpose` enviado fora do conjunto suportado
`401`	`authentication_failed`	API key ausente, inválida ou revogada

O limit é ajustado para o intervalo de 1 a 100; apenas um purpose fora do conjunto suportado gera 400 nessa listagem.

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

{
  "object": "list",
  "data": [
    {
      "id": "file_7TWEdpzCfXHWA52K",
      "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_7TWEdpzCfXHWA52K"
    }
  ],
  "has_more": false,
  "url": "/v1/files"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid purpose filter",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Autenticação

Parâmetros de query

Resposta

Erros comuns

​Autenticação

​Parâmetros de query

​Resposta

​Erros comuns

Autenticação

Parâmetros de query

Resposta

Erros comuns