Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, kuruluş kimliğinizi doğrudan URL içinde orgId olarak alır. Bunu yola ekleyin; bunun yerine geçecek hiçbir başlık veya sorgu parametresi yoktur.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
Returns a single organization the principal can access. RLS-scoped.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
orgId (path) | Uuid | Evet | Organization ID (UUIDv7). |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Evet | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Hayır | Parent in the tenancy tree; null for a top-level org. |
name | string | Evet | — |
brand_id | object | Hayır | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Evet | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Evet | — |
created_at | string | Evet | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 429