Skip to main content
Get an Organization
curl --request GET \
  --url https://api.chargefy.io/v1/organizations/{id}
{
  "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"
}
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

CredencialAcesso
JWT de usuárioRequer acesso à organização.
API key da organizaçãoApenas a própria organização da key.
API key da plataformaOrganizações conectadas ativas da plataforma.

​
Parâmetros de caminho

​
id
string
required
ID da organização.
curl -X GET "https://api.chargefy.io/v1/organizations/org_123" \
  -H "Authorization: Bearer {{API_KEY}}"

​
Resposta

​
id
string
ID público da organização.
​
object
string
Sempre "organization".
​
livemode
boolean
true em produção; false em ambiente de teste quando a leitura vem de uma API key de plataforma em modo teste.
​
name
string
Nome público da organização.
​
email
string | null
E-mail principal.
​
avatar_url
string | null
URL do logo/avatar.
​
document
string | null
CPF/CNPJ normalizado, somente dígitos.
​
document_type
string | null
cpf ou cnpj.
​
website
string | null
Site público.
​
socials
array
Lista [{ platform, url }].
​
billing_name
string | null
Nome usado em cobranças.
​
billing_address
object | null
Endereço de cobrança.
​
billing_additional_info
string | null
Informação adicional de cobrança.
​
branding_settings
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.
​
created_at
string
Quando a organização foi criada.
​
updated_at
string | null
Última modificação da organização.
​
bank_account
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.
​
platform
string | null
ID da plataforma quando a leitura usa API key de plataforma; caso contrário null.
​
activation_status
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.
​
activation_status_updated_at
string | null
Data/hora da última atualização de activation_status.
​
metadata
object
Metadata da relação plataforma↔organização conectada. {} fora de contexto de plataforma.
{
  "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"
}