Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; 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/site-groups \
-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
Every group in scope with its member count, plus whether this caller's plan lets them create one and the colours a group may be drawn in. Gated on sites.view — a group is a view of sites the caller can already see.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already read, so an org… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
items | SiteGroup[] | Yes | — |
can_create | boolean | Yes | Whether any organisation in scope sells site_groups. The screen renders the create control as ABSENT rather than disabled when this is false — an inert button that never… |
colours | string[] | Yes | — |
Errors this endpoint can return
401 · 403