Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
X-Zinn-Org (header) | string | Nie | **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 | Nie | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Nie | Maximum items to return (page size). |
status (query) | DomainStatus | Nie | Filter by domain lifecycle status. |
org_id (query) | Uuid | Nie | Restrict to one organization in scope. |
tld (query) | string | Nie | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
data | Domain[] | Tak | — |
page | PageMeta | Tak | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 422 · 429