Skip to main content
GET
List tenant users across organizations (BO, paginated/filterable)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "roles": Adds each role assignment's role { id, name, systemKey }, unitIds and itIds.
  • "organization": Adds organization { id, name }.
Available options:
roles,
organization
orderBy
object[]
whereOrganizationId
string<uuid>

Filter by organization id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
whereType
string[]

Filter by one or more user types (rs, ad, na).

Example:

Case-insensitive search across the identity name and email.

Maximum string length: 200
Example:

"lobby"

whereActivated

Filter by activation state (true = the identity has activated its account; na users are always pending).

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required