List organization users

Lists the people of the organization's workspaces in the current region, one row per email. The list has two parts. The roster holds permanent direct and group-derived workspace members, visible invitations, and pending assignments of people that a customer's directory pushed (status assigned, or seat_denied after a grant failed for lack of a seat). The tail holds the pushed people with no access entry, each with an empty workspace_access and the status no_access. The tail always comes after the roster. One cursor pages the two parts: first rows a page, 100 when not given, at most 100, and after set to page_metadata.end_cursor. last and before answer 400: the cursor goes forward only. A cursor of another sort answers 400. search matches a part of the name or the email, and ignores case. origin applies to the person. workspace_ids, roles and status must all match one entry of the person: workspace_ids=A&roles=admin keeps the admins of A only. has_api_keys keeps the people with or without API keys. A filter keeps the tail only when workspace_ids and roles are not given, has_api_keys is not true, status is not given or holds no_access, and origin is not given or holds directory. The answer has every visible entry of a kept person. page_metadata.total_count is the kept roster rows plus the kept tail rows of all pages. Pending assignments and the tail exist only for SSO connections that use the directory user model. Each person takes one seat, at their highest permanent billable direct role in the local workspaces; a pending assignment takes none. The seat distribution does not follow the filters. Requires organization administration permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Query Params
roles
array of strings

Keeps a person with an entry of one of the roles.

OrganizationUsers.RoleFilter
Allowed:
workspace_ids
array of objects | null
Defaults to []
Common.UUIDList
status
array of strings

Keeps a person with an entry of one of the statuses. no_access keeps the tail of the list.

OrganizationUsers.StatusFilter
Allowed:
origin
array of strings

Keeps a person of one of the origins. The tail has the origin directory.

OrganizationUsers.OriginFilter
Allowed:
boolean
order_by
array of strings
length ≤ 1

The sort column, name when not given. role uses the highest role of the person. status uses the order of the status field. last_active puts null last in both directions. The tail of the list always comes last. It sorts by name or email, and by name for the other columns.

OrganizationUsers.OrderBy
Allowed:
order_directions
array of strings
length ≤ 1

The sort direction, asc when not given.

OrganizationUsers.OrderDirections
Allowed:
integer | null

The number of records to return after the provided cursor; used in combination with after

integer | null

The number of records to return for before the provided cursor; used in combination with before

string | null

A base64 encoded value representing a cursor, or an element ID if applicable

string | null

A base64 encoded value representing a cursor, or an element ID if applicable

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json