GET /api/v1/organizations/:id

Retorna os detalhes de uma organização específica

Retorna todos os dados de uma organização pelo seu ID. O usuário autenticado deve pertencer à organização.

​

Autenticação

Requer token de usuário (JWT Supabase) via header Authorization: Bearer.

​

Parâmetros de Path

id · string · required

ID da organização

​

Resposta

id · string

ID único da organização

name · string

Nome da organização

slug · string

Slug único para URL

avatar_url · string

URL do avatar

bio · string

Biografia/descrição

company · string

Nome da empresa

blog · string

URL do blog

location · string

Localização

email · string

E-mail de contato

twitter_username · string

Usuário no Twitter/X

website · string

Site da organização

status · string

Status: created, active, denied

next_review_threshold · integer

Limite de volume antes da próxima revisão

profile_settings · object

Configurações de perfil

feature_settings · object

Configurações de funcionalidades

subscription_settings · object

Configurações de assinaturas

notification_settings · object

Configurações de notificações

customer_invoice_prefix · string

Prefixo das faturas

customer_invoice_next_number · integer

Próximo número de fatura

socials · array

Links de redes sociais

details · object

Detalhes adicionais submetidos

created_at · string

Data de criação (ISO 8601)

modified_at · string

Data de última modificação (ISO 8601)

onboarded_at · string

Data de conclusão do onboarding (ISO 8601)

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/organizations/org_abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "id": "org_abc123",
  "name": "Minha Empresa",
  "slug": "minha-empresa",
  "avatar_url": "https://cdn.chargefy.io/avatars/org_abc123.png",
  "bio": "Empresa de tecnologia",
  "email": "[e-mail]",
  "website": "https://minhaempresa.com.br",
  "status": "active",
  "next_review_threshold": 0,
  "profile_settings": {},
  "feature_settings": {},
  "subscription_settings": {
    "allow_multiple_subscriptions": false,
    "allow_customer_updates": true,
    "proration_behavior": "prorate"
  },
  "notification_settings": {
    "new_sale": true,
    "new_subscription": true
  },
  "customer_invoice_prefix": "MINHAEMPRESA",
  "customer_invoice_next_number": 42,
  "socials": [],
  "details": {},
  "created_at": "2025-06-01T08:00:00Z",
  "modified_at": "2025-06-10T14:30:00Z",
  "onboarded_at": "2025-06-02T10:00:00Z"
}