hosting

GET `/v1/sites`

List sites in scope.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

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/sites \
  -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

Lists the sites the principal can view across its tenancy subtree. Cursor-paginated. RLS guarantees no site outside the principal's subtree is ever returned (CLAUDE.md §2.3). Sites with status deleted are not listed by default — they are a terminal state with their own endpoint, GET /v1/sites/deleted, which also reports how long each one stays recoverable. Pass status=deleted explicitly to list them here. Every other status, including deleting, is listed as normal.

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).
`org_id (query)`	`Uuid`	Ne	Restrict to one organization in scope (default — the whole subtree).
`status (query)`	`SiteStatus`	Ne	Filter by site lifecycle status. Omitted, every status except `deleted` is returned; pass `deleted` to list deleted sites here rather than at `GET /v1/sites/deleted`.
`product_line (query)`	`string`	Ne	Filter by product line code (e.g. `footprint_free`, `mainstream`).
`group (query)`	`string`	Ne	Restrict to the sites in one site group (#2729). A group id belonging to another tenant matches nothing and returns an empty page rather than a 404 — the queryset is already…
`search (query)`	`string`	Ne	Case-insensitive substring match on the site's primary domain or its name. Applied in the database across the whole collection in scope — not to the page already fetched — so a…
`ordering (query)`	`string<domain, -domain, name, -name, status, -status, line, -line, stack, -stack, region, -region, plan, -plan, created, -created, authority, -authority, indexed, -indexed>`	Ne	Sort key, optionally `-`-prefixed for descending. Defaults to `-created` (newest first). Sorting is applied across the whole collection and the cursor carries the sort position,…

Odpověď

Název	Typ	Požadováno	Co to je
`data`	`Site[]`	Ano	—
`page`	`PageMeta`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 422 · 429