Members — API reference

GET/api/v1/members

List the org's members

The people who are members of the org, by name, each with their email, their org roles and their teams. Every credential sees emails: members see each other's in the app. For an OAuth token, its person needs membership of the org (no platform-admin bypass); a key reads the whole org. 404 when the org does not have organization settings, and for an OAuth token whose person is not a member.

Scopes: org:read

Parameters

qquery · string
Case-insensitive substring of the name or the email.
limitquery · integer
Page size, default 50. Values above 100 are treated as 100.
cursorquery · string
next_cursor from the previous page, with the other parameters unchanged.

Response 200MemberList

dataarray of Memberrequired
By name, then id.
- idstring (uuid)required
  The member's principal id in this org.
- namestringrequired
- emailstringrequired
  Served to every credential: members see each other's email in the app.
- rolesarray of objectrequired
  The org roles assigned to the member, by name.
  - idstring (uuid)required
  - namestringrequired
- teamsarray of objectrequired
  The teams the member belongs to (archived teams left out), by name.
  - idstring (uuid)required
  - namestringrequired
- joined_atstring (date-time)required
  When the member joined the org.
next_cursorstring or nullrequired
Pass as cursor to get the next page; null means this is the last page.

Other responses

401 unauthenticated — no key, or an unknown, revoked or expired one.
403 insufficient-scope — the key lacks a required scope.
404 not-found.
422 validation — a bad limit or cursor (errors[].path names it).
429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
500 internal.