Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Unde merge ID-ul organizației tale
Acest punct final preia ID-ul organizației tale direct în URL, sub forma orgId. Înlocuiește-l în cale — nu există niciun antet sau parametru de interogare care să țină locul acestuia.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
Returns a single organization the principal can access. RLS-scoped.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
orgId (path) | Uuid | Da | Organization ID (UUIDv7). |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Da | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Nu | Parent in the tenancy tree; null for a top-level org. |
name | string | Da | — |
brand_id | object | Nu | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Da | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Da | — |
created_at | string | Da | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 429