Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този краен пункт приема идентификатора на вашата организация директно в URL адреса като orgId. Заменете го в пътя — няма заглавна част или заявков параметър, които да го заместят.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Returns a single organization the principal can access. RLS-scoped.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
orgId (path) | Uuid | Да | Organization ID (UUIDv7). |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Да | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Не | Parent in the tenancy tree; null for a top-level org. |
name | string | Да | — |
brand_id | object | Не | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Да | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Да | — |
created_at | string | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429