Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Kung saan mapupunta ang id ng iyong organisasyon
Kinukuha ng endpoint na ito ang id ng iyong organisasyon sa mismong URL bilang orgId. Palitan ito sa path — walang header o query parameter na gagawa nito sa halip.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
Returns a single organization the principal can access. RLS-scoped.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
orgId (path) | Uuid | Oo | Organization ID (UUIDv7). |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Oo | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Hindi | Parent in the tenancy tree; null for a top-level org. |
name | string | Oo | — |
brand_id | object | Hindi | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Oo | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Oo | — |
created_at | string | Oo | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 429