access
GET /v1/sites/{siteId}/collaborator-roles
The per-site roles that may be granted here.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/{siteId}/collaborator-roles \
-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
The roles a collaborator may be given on this site, so a form offers only choices the engine will accept. Fixed today; it exists because the first time a plan tier or a reseller policy limits which per-site roles may be conferred, every screen that hardcoded three choices is silently wrong and one that asked is not. `collaborator_role_seeded` reports whether the underlying organisation role exists in this deployment. It distinguishes *"nobody has been granted anything yet"* from *"the role catalogue was never seeded, so every grant will fail to narrow"* — two states that otherwise look identical from an empty list.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
items | object[] | Yes | — |
collaborator_role_seeded | boolean | Yes | Whether the `site_collaborator` organisation role exists in this deployment. See the endpoint description: it separates an empty answer from a blind one. |
Errors this endpoint can return
401 · 403 · 404 · 429