access

GET /v1/orgs/{orgId}/members

List the people in an organization.

Alle access-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie members.read beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt gebruikt je organisatie-id rechtstreeks in de URL als orgId. Vervang dit in het pad; er is geen header of queryparameter die dit kan overnemen.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/members \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

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.

Parameters

NaamTypeVerplichtWat dit is
orgId (path)UuidJaOrganization ID (UUIDv7).
cursor (query)stringNeeOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNeeMaximum items to return (page size).

Reactie

NaamTypeVerplichtWat dit is
dataOrgMember[]Ja
pagePageMetaJa

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 429