Skip to content

List members

List an organization's members, their roles, additional commands and withheld commands. Use organization invitation view for people who have yet to join.

Parameters

#
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobject[]Always present
Organization members and their permissions.
Show 1 attributeHide attributes
itemsobject
An organization member and their permissions.
Show 9 attributesHide attributes
emailstring | nullAlways present
Their email address, or null without one.
grant_scopestring
Resources reached by additional command grants. May be omitted.
grantsstring[]
Commands granted beyond the role. May be omitted.
namestring
Their saved display name, when available. May be omitted.
picturestring
Their profile picture URL. May be omitted.
rolestringAlways present
Their organization role.
teamsstring[] | nullAlways present
Teams this person belongs to.
user_idstringAlways present
Member's user ID.
withholdsstring[]
Commands withheld from the role. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: organization member view.