Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil ID organisasi anda dalam URL itu sendiri, sebagai orgId. Gantikannya ke dalam laluan — tiada pengepala atau parameter pertanyaan yang akan melakukan sebaliknya.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
Returns a single organization the principal can access. RLS-scoped.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
orgId (path) | Uuid | Ya | Organization ID (UUIDv7). |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Ya | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Tidak | Parent in the tenancy tree; null for a top-level org. |
name | string | Ya | — |
brand_id | object | Tidak | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Ya | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Ya | — |
created_at | string | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 429