Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přebírá ID vaší organizace přímo v URL jako orgId. Dosaďte jej do cesty – neexistuje žádná hlavička ani parametr dotazu, které by to udělaly místo toho.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Returns a single organization the principal can access. RLS-scoped.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
orgId (path) | Uuid | Ano | Organization ID (UUIDv7). |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Ano | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Ne | Parent in the tenancy tree; null for a top-level org. |
name | string | Ano | — |
brand_id | object | Ne | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Ano | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Ano | — |
created_at | string | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 429