organisation
List members
/api/v1/organisation/members
The members of the organisation with their root role, one page at a time.
key
Required scope: org:admin
Query parameters
-
qstring · optionalWhat to look for, 2 to 200 characters.
-
rolestring or null · optionalOnly the members with this root role:
admin,editororreader. -
limitinteger · optionalPage size, 1 to 200 (default 50).
-
cursorstring or null · optionalnext_cursorof the previous page.
Response
200
Members
-
itemsarray of MemberOne page of members.
6 fields
-
idintegerId of the member.
-
emailstringTheir address.
-
first_namestringFirst name; may be empty.
-
last_namestringLast name; may be empty.
-
rolestringRoot role:
admin,editororreader. -
registeredbooleanfalsewhile the person has not accepted their invitation.
-
-
next_cursorstring or nullWhat to send as
cursorfor the next page;nullon the last one.
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
422
A value is missing or malformed.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.