Authentication
Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
X-Zinn-Org (header) | string | No | 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 | No | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | No | Maximum items to return (page size). |
org_id (query) | Uuid | No | Restrict to one organization in scope (default — the whole subtree). |
status (query) | SiteStatus | No | 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 | No | Filter by product line code (e.g. footprint_free, mainstream). |
group (query) | string | No | 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… |
server (query) | string | No | Restrict to the sites on one server — a key from listSiteServers (and from each row's server.key): own:<uuid>, panel:<uuid>, fleet:<region>-<n>, or one of edge,… |
search (query) | string | No | 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> | No | 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,… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | Site[] | Yes | — |
page | PageMeta | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429