> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/v1/customers/export

> Exporta todos os clientes da organização em formato CSV

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](https://scaleup-c34c4386.mintlify.site/guides/parent-marketplace-suborganizations.md).

## 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:**

| Coluna | Descrição |
| - | - |
| `ID` | ID único interno do cliente no Chargefy. |
| `External ID` | ID externo definido pelo sistema integrado (se houver). |
| `Created At` | Data e hora de criação do registro. |
| `Email` | Endereço de email do cliente. |
| `Name` | Nome completo do cliente. |
| `Tax ID` | CPF ou CNPJ do cliente. |
| `Billing Address Line 1` | Logradouro e número do endereço de cobrança. |
| `Billing Address Line 2` | Complemento do endereço. |
| `Billing Address City` | Cidade do endereço de cobrança. |
| `Billing Address State` | Estado (UF) do endereço de cobrança. |
| `Billing Address Zip` | CEP do endereço de cobrança. |
| `Billing Address Country` | País do endereço de cobrança (formato ISO 3166-1 alpha-2). |
| `Metadata` | Metadados personalizados serializados em JSON (se houver). |

## Exemplo

```bash cURL theme={null}
curl -X GET "https://api.chargefy.io/api/v1/customers/export" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -o chargefy-clientes.csv
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const csv = await chargefy.customers.export();
// csv é uma string com o conteúdo do arquivo CSV
```

## Resposta de Exemplo

```csv theme={null}
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,joao@exemplo.com,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,maria@exemplo.com,Maria Silva,98765432100,Rua das Flores 50,Apto 3,Curitiba,PR,80010-020,BR,{}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.