access

GET /v1/orgs/{orgId}/members

List the people in an organization.

Alle access Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung members.read verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt erwartet Ihre Organisations-ID direkt in der URL als orgId. Setzen Sie diese in den Pfad ein – es gibt keinen Header oder Abfrageparameter, der stattdessen verwendet werden kann.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

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/orgs/{orgId}/members \
  -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 org's members with their roles, paged over **users** (a person holding two roles is one row, not two). Each row carries `removable` and, when false, `not_removable_reason` — the engine's own answer, so a client never re-derives the removal policy and offers a button that will be refused. Requires `members.read`; a caller without `members.remove` sees `removable: false` on everyone.

Parameter

NameTypErforderlichWas es ist
orgId (path)UuidJaOrganization 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
dataOrgMember[]Ja
pagePageMetaJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429