access

GET /v1/sites/{siteId}/collaborators

Who this site is shared with.

Alle access Endpunkte

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}/collaborators \
  -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

Per-site collaborators — one person's access to ONE site, rather than to the whole organisation. Every grant on this site, newest first, live and lapsed alike: a revoked grant is kept because *"who could reach this site in March"* is the question an incident asks, and a deleted row cannot answer it. ⛔ Read and write share the `sites.collaborators.manage` permission. The list is the access-control state of the site — who else is in it, at what level, and why — and that is an account owner's business rather than a developer's. Among the customer roles only `owner` holds the key; `dev` deliberately does not, because a developer who could grant site access could grant it to themselves on a site they were never given. A site outside the caller's scope, and a site they can see but may not administer, both answer `404`. Same code, two reasons: a `403` on the second would tell a developer that a collaborator list exists on their client's site, and a `403` on the first is an existence oracle.

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).
cursor (query)stringNeinOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNeinMaximum items to return (page size).

Antwort

NameTypErforderlichWas es ist
dataSiteCollaborator[]Ja
pagePageMetaJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429