Skip to main content
GET
List users
Each user in data includes assignedInApps, the apps the user can access and the role in each. Use the filters to find users by role, app, status, or member type. A user must match every filter you send.
Users are ordered by _id, highest first, unless you send asc or dsc.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Query Parameters

active
string

Return only active users with true, or only inactive users with false.

Pattern: ^(true|false)$
appId
string[]

Return users who have access to this app. Only bms can be assigned through the API. Repeat the parameter to match any of several apps.

asc
string

Field to sort by, lowest first, for example email. Use a field name from the response. An unknown field is accepted and the order is then not defined.

dsc
string
default:_id

Field to sort by, highest first. Defaults to _id.

limit
integer<int32>
default:50

Number of users per page, from 1 to 200.

Required range: 1 <= x <= 200
memberType
string

Return only INTERNAL users or only GUEST users. The value is case-sensitive.

Pattern: ^(INTERNAL|GUEST)$
page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
q
string

Search text. Matches users by email address. The match is not case-sensitive and can start anywhere in the value. Characters other than letters, digits, spaces, and @ are ignored, so a term made only of other characters returns an empty page.

role
string[]

Return users with this organization role, for example CLIENT_ADMIN. Repeat the parameter to match any of several roles.

Response

A page of users. itemCount is the total number of users that match the filters.

data
object[]
page
integer<int32>
limit
integer<int32>
pageCount
integer<int32>
itemCount
integer<int32>