Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita o ID da sua organização diretamente na URL, como orgId. Substitua-o no caminho — não há cabeçalho ou parâmetro de consulta que sirva como alternativa.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Returns a single organization the principal can access. RLS-scoped.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
orgId (path) | Uuid | Sim | Organization ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Sim | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Não | Parent in the tenancy tree; null for a top-level org. |
name | string | Sim | — |
brand_id | object | Não | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Sim | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Sim | — |
created_at | string | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429