Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
X-Zinn-Org (header) | string | Ne | **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 | Ne | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Ne | Maximum items to return (page size). |
status (query) | DomainStatus | Ne | Filter by domain lifecycle status. |
org_id (query) | Uuid | Ne | Restrict to one organization in scope. |
tld (query) | string | Ne | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
data | Domain[] | Ano | — |
page | PageMeta | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422 · 429