Skip to main content
Gera e retorna um arquivo CSV com todos os clientes ativos da organização. O arquivo inclui dados de identificação, endereço de cobrança e metadados. Útil para auditorias, importações em outras ferramentas ou backups.

​
Autenticação

Requer Organization Access Token (OAT) via header Authorization: Bearer. Escopos necessários: web:read, web:write, customers:read ou customers:write.

​
Organização pai (marketplace)

Com OAT da org pai, se você omitir organization_id, o CSV inclui clientes da sua org e de todas as sub-organizações diretas. Com organization_id informado, exporta só essa org (deve ser a sua ou um filho direto). Usuário (sessão) continua precisando de organization_id quando aplicável. Guia: Marketplace: OAT da organização pai e sub-organizações.

​
Parâmetros de Query

​
organization_id
string
OAT org única / filho: exporta só essa organização.OAT pai: opcional — omitir para export agregado (pai + filhos).Usuário: sempre obrigatório ao usar token de sessão (usuário). A API retorna 400 caso seja omitido nesse contexto.

​
Resposta

Retorna um arquivo com Content-Type: text/csv. O nome sugerido do arquivo é chargefy-clientes.csv. Colunas do CSV:
ColunaDescrição
IDID único interno do cliente no Chargefy.
External IDID externo definido pelo sistema integrado (se houver).
Created AtData e hora de criação do registro.
EmailEndereço de email do cliente.
NameNome completo do cliente.
Tax IDCPF ou CNPJ do cliente.
Billing Address Line 1Logradouro e número do endereço de cobrança.
Billing Address Line 2Complemento do endereço.
Billing Address CityCidade do endereço de cobrança.
Billing Address StateEstado (UF) do endereço de cobrança.
Billing Address ZipCEP do endereço de cobrança.
Billing Address CountryPaís do endereço de cobrança (formato ISO 3166-1 alpha-2).
MetadataMetadados personalizados serializados em JSON (se houver).

​
Exemplo

curl -X GET "https://api.chargefy.io/api/v1/customers/export" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -o chargefy-clientes.csv

​
Resposta de Exemplo

ID,External ID,Created At,Email,Name,Tax ID,Billing Address Line 1,Billing Address Line 2,Billing Address City,Billing Address State,Billing Address Zip,Billing Address Country,Metadata
cus_def456,user_001,2026-03-12T10:00:00Z,[email protected],João Santos,12345678901,Av. Paulista 1000,,São Paulo,SP,01310-100,BR,"{""source"":""api"",""plan"":""pro""}"
cus_abc123,user_002,2026-02-15T08:30:00Z,[email protected],Maria Silva,98765432100,Rua das Flores 50,Apto 3,Curitiba,PR,80010-020,BR,{}