אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
X-Zinn-Org (header) | string | לא | **Which organisation this call acts for.** Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | לא | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | לא | Maximum items to return (page size). |
status (query) | DomainStatus | לא | Filter by domain lifecycle status. |
org_id (query) | Uuid | לא | Restrict to one organization in scope. |
tld (query) | string | לא | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | לא | Restrict to the domain backing one site — the link a site's DNS screen follows to reach the zone it should edit. Scoped by the same RLS filter as everything else here, so a site… |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
data | Domain[] | כן | — |
page | PageMeta | כן | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 422 · 429