Skip to main content
GET
List the organization's rs + na users

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 }, unitIds and itIds.
  • "profession": Adds profession { id, name, color } (default select only has professionId).
  • "activation-status": Adds pending (true while the identity has not activated its account yet).
  • "actions-info": Adds actions { canBeArchived, canBeUnarchived } per row.
  • "units": Adds units { id, ref, name } - the units the user is posted to.
  • "responsibilities": Adds responsibilities - what this user is responsible for, with each target named.
Available options:
roles,
profession,
activation-status,
actions-info,
units,
responsibilities
orderBy
object[]

Case-insensitive search across the identity name and email.

Maximum string length: 200
Example:

"lobby"

whereType
string[]

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

Example:
whereAffiliation
string[]

Filter by one or more affiliations.

Example:
whereProfessionId
string<uuid>[]

Filter by one or more profession ids.

Maximum array length: 250
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)$
Example:
whereRoleId
string<uuid>[]

Filter by one or more assigned role ids.

Maximum array length: 250
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)$
Example:
whereUnitIds
string<uuid>[]

Filter by one or more units the user is posted to.

Maximum array length: 250
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)$
Example:
whereActivated

Filter by activation state (true = the identity has activated its account).

Example:

true

whereArchived

When true, only archived users; when false, only non-archived.

Example:

true

whereComplianceStatus
string[]

Filter by the derived status (not_started, on_time, at_risk, overdue) of the user’s own compliances (qualifications).

Example:

Response

Default Response

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