אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את מזהה הארגון שלך בכתובת ה-URL עצמה, בתור orgId. השתמש בו בנתיב — אין כותרת או פרמטר שאילתת חיפוש שיעשו זאת במקומו.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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 | כן | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 429