Skip to main content
GET
List organization users
Filter by ids, status, level (the access level in this organization), realmLevel (the access level in the realm), hasPin, hasMfa, or a text match on name, email or document. A list filter takes its values comma-separated (?level=ADMIN,USER); repeating the parameter (?level=ADMIN&level=USER) works too. A page holds up to 100 users (limit); send the previous page’s next cursor for the following one. The organization’s active admins, for example, are ?level=ADMIN&status=ACTIVE&limit=100.

Path Parameters

realmId
string
required
organizationId
string
required

Query Parameters

ids
string<uuid>[]

Only the users with these IDs.

Format: UUID


Example (comma-separated list): ?ids=8f1c2d3e-4b5a-4c6d-9e7f-a1b2c3d4e5f6,29bfc458-6d62-4e37-9a89-dc620926bae5

Maximum array length: 100
name
string

Only users whose first or last name contains each word of this text (case-insensitive), or whose e-mail contains the whole text.

Maximum string length: 200
email
string

Only users whose e-mail contains this text (case-insensitive).

Maximum string length: 200
document
string

Only users whose document (CPF) contains these characters. Punctuation is ignored, so 123.456 and 123456 match the same users.

Maximum string length: 32
status
enum<string>[]

Only users in one of these statuses.


Example (comma-separated list): ?status=ACTIVE,IN_ONBOARDING

Available options:
IN_ONBOARDING,
CREATING,
ACTIVE,
DEACTIVATED,
BLOCKED
level
enum<string>[]

Only users with one of these access levels in the organization.


Example: ?level=ADMIN

Available options:
ADMIN,
USER
realmLevel
enum<string>[]

Only users with one of these access levels in the realm.


Example: ?realmLevel=ADMIN

Available options:
ADMIN,
USER
hasPin
(boolean | string)[]

Only users who set up a transaction PIN (true) or did not (false).


Example: ?hasPin=true

hasMfa
(boolean | string)[]

Only users who enabled multi-factor authentication (true) or did not (false).


Example: ?hasMfa=true

limit
integer

Page size, 1–100. Defaults to 15.

Required range: 1 <= x <= 100
next
string

Cursor returned as next by the previous page. Omit for the first page.

orderBy
string

Field to sort by. Defaults to createdAt.

Maximum string length: 64
order
string

Sort direction, ASC or DESC. Defaults to DESC (newest first).

Maximum string length: 8

Response

Successful response

A page of the organization's users.

next
string | null
required

Cursor for the next page: send it as the next query parameter. null on the last page.

Example:

"NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5"

items
object[]
required

The users on this page.