> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an Organization

> Retorna uma organização pelo ID.

Retorna o objeto `organization` completo.

Quando a chamada usa API key de plataforma, os campos de contexto da relação (`platform`, `activation_status`, `activation_status_updated_at` e `metadata`) são preenchidos para a organização conectada ativa. Com JWT ou API key de organização, esses campos vêm como `null` ou `{}` porque a leitura não acontece pela lente de uma plataforma específica.

## Autenticação

| Credencial             | Acesso                                        |
| ---------------------- | --------------------------------------------- |
| JWT de usuário         | Requer acesso à organização.                  |
| API key da organização | Apenas a própria organização da key.          |
| API key da plataforma  | Organizações conectadas ativas da plataforma. |

## Parâmetros de caminho

<ParamField path="id" type="string" required>
  ID da organização.
</ParamField>

```bash theme={}
curl -X GET "https://api.chargefy.io/v1/organizations/org_123" \
  -H "Authorization: Bearer {{API_KEY}}"
```

## Resposta

<ResponseField name="id" type="string">
  ID público da organização.
</ResponseField>

<ResponseField name="object" type="string">
  Sempre `"organization"`.
</ResponseField>

<ResponseField name="livemode" type="boolean">
  `true` em produção; `false` em ambiente de teste quando a leitura vem de uma API key de plataforma em modo teste.
</ResponseField>

<ResponseField name="name" type="string">
  Nome público da organização.
</ResponseField>

<ResponseField name="email" type="string | null">
  E-mail principal.
</ResponseField>

<ResponseField name="avatar_url" type="string | null">
  URL do logo/avatar.
</ResponseField>

<ResponseField name="document" type="string | null">
  CPF/CNPJ normalizado, somente dígitos.
</ResponseField>

<ResponseField name="document_type" type="string | null">
  `cpf` ou `cnpj`.
</ResponseField>

<ResponseField name="website" type="string | null">
  Site público.
</ResponseField>

<ResponseField name="socials" type="array">
  Lista `[{ platform, url }]`.
</ResponseField>

<ResponseField name="billing_name" type="string | null">
  Nome usado em cobranças.
</ResponseField>

<ResponseField name="billing_address" type="object | null">
  Endereço de cobrança.
</ResponseField>

<ResponseField name="billing_additional_info" type="string | null">
  Informação adicional de cobrança.
</ResponseField>

<ResponseField name="branding_settings" type="object">
  Identidade visual aplicada ao checkout hospedado: `brand_color`, `accent_color`, `font_family`, `theme`, `border_style`. Sempre presente; campos não configurados vêm `null` (a página hospedada usa o padrão do sistema). Configurável via [update](/api-reference/organizations/update).
</ResponseField>

<ResponseField name="created_at" type="string">
  Quando a organização foi criada.
</ResponseField>

<ResponseField name="updated_at" type="string | null">
  Última modificação da organização.
</ResponseField>

<ResponseField name="bank_account" type="object | null">
  Conta bancária ativa conectada à organização. Use este campo para exibir
  banco, agência/roteamento, titular e últimos 4 dígitos no admin da plataforma.
  `null` quando não há conta conectada. O número completo da conta nunca é
  retornado.
</ResponseField>

<ResponseField name="platform" type="string | null">
  ID da plataforma quando a leitura usa API key de plataforma; caso contrário `null`.
</ResponseField>

<ResponseField name="activation_status" type="string | null">
  Status financeiro da organização conectada: `activation_pending`, `pending`,
  `active` ou `disabled`. `disabled` significa que o perfil financeiro atual
  não está apto; a organização pode iniciar uma nova tentativa de onboarding.
  `null` fora de contexto de plataforma.
</ResponseField>

<ResponseField name="activation_status_updated_at" type="string | null">
  Data/hora da última atualização de `activation_status`.
</ResponseField>

<ResponseField name="metadata" type="object">
  Metadata da relação plataforma↔organização conectada. `{}` fora de contexto de plataforma.
</ResponseField>

<ResponseExample>
  ```json 200 theme={}
  {
    "id": "org_123",
    "object": "organization",
    "activation_status": "activation_pending",
    "activation_status_updated_at": null,
    "avatar_url": "https://storage.chargefy.io/file_NtkQ6yYhdBJrXlcw",
    "bank_account": null,
    "billing_additional_info": null,
    "billing_address": {
      "city": "São Paulo",
      "country": "BR",
      "line1": "Av. Paulista, 1000",
      "line2": null,
      "postal_code": "01310-100",
      "state": "SP"
    },
    "billing_name": "Acme Ltda",
    "branding_settings": {
      "accent_color": "#FF6B00",
      "border_style": "rounded",
      "brand_color": "#1B1B1B",
      "font_family": null,
      "theme": "light"
    },
    "created_at": "2026-05-16T14:09:27Z",
    "document": "12345678000190",
    "document_type": "cnpj",
    "email": "contato@meusite.com",
    "livemode": true,
    "metadata": {
      "external_account_id": "acct_987"
    },
    "name": "Acme Ltda",
    "platform": "plat_456",
    "socials": [
      {
        "platform": "instagram",
        "url": "https://instagram.com/meusite"
      }
    ],
    "updated_at": "2026-05-16T14:20:00Z",
    "website": "https://meusite.com"
  }
  ```
</ResponseExample>