List members
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/members
The members of the organization, with their role, authentication role, insights access and whether they are active. Optionally only those with a status, active or deactivated, or with an email.
Requires the users:read scope. Only owners and admins of the organization may call it.
Operation ID: listMembers. Only owners and admins can call it.
Query parameters
status(string): Only returnactivemembers, or onlydeactivatedones. If omitted, returns both. One ofactive,deactivated.email(string): Only return the member with exactly this email address, ignoring case. Returns an empty list if no member has it, or if they don't matchstatus. Example:jane@acme.com.
Response 200
Success
application/json: array of object
id(number, required): Unique identifier for the member. Pass it asuserIdtoupdateMember,deactivateMemberorreactivateMember.email(string, required): The email address of the member's Rollstack account.name(string, required): The member's name, as shown in Rollstack.role(string, required): The member's role in the organization.ownercan do everything, including turning the organization's features on or off, choosing who can access its Authentication settings and, in the app, making other members owners.adminmanages the organization's settings, members and invites, but can't turn features such as Insights or email analytics on or off, or change, deactivate or reactivate owners.memberuses Rollstack without managing the organization. One ofowner,admin,member.authenticationRole(string or null, required): The member's access to the organization's Authentication settings, where Single Sign-On (SSO) and SCIM provisioning are set up:viewercan see them,editorcan also change them, andnullgives no access. Owners always have full access, whatever this value. One ofviewer,editor.insightsEnabled(boolean, required): Whether the member can use Insights while the organization restricts them to the members it picks (restrictInsightUsersinupdateOrganization). It has no effect while Insights are open to every member or turned off.status(string, required): Whether the member has access to the organization.activemembers do.deactivatedmembers were removed from it, which revoked their API keys;reactivateMemberrestores their access, but not their keys. One ofactive,deactivated.deactivatedAt(string (date-time) or null, required): When the member was deactivated.nullwhile they're active.deactivationReason(string or null, required): Why the member was deactivated: the reason an admin gave, orsso_deprovisionedwhen SSO removed them.nullwhile they're active, or when no reason was given. One ofleft_company,no_longer_needs_access,not_using_enough,too_expensive,switching_tool,duplicate_account,sso_deprovisioned,other.deactivationReasonDetails(string or null, required): What the admin wrote whendeactivationReasonisother.nullotherwise.