access
GET /v1/sites/{siteId}/collaborator-roles
The per-site roles that may be granted here.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/collaborator-roles \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
items | object[] | Ja | — |
collaborator_role_seeded | boolean | Ja | Whether the `site_collaborator` organisation role exists in this deployment. See the endpoint description: it separates an empty answer from a blind one. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429