Skip to main content
GET
Export organization users
Only organization admins can export. The file format goes in the required type query parameter: ?type=csv answers a UTF-8 CSV file, ?type=xlsx an Excel workbook returned base64-encoded. The organization user list’s filters apply here too (status, level, name, …; a list filter takes its values comma-separated, ?status=ACTIVE,IN_ONBOARDING). The file lists up to 1,000 users, newest first, with their name, e-mail, status, access level, creation date and whether they set up multi-factor authentication and a PIN.

Path Parameters

realmId
string
required
organizationId
string
required

Query Parameters

type
enum<string>
required

The file format: csv for a UTF-8 CSV file, xlsx for an Excel workbook returned base64-encoded.

Available options:
csv,
xlsx
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

next
string

Cursor returned as next by the previous page of the organization user list. Omit to export from the first user.

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

application/csv — The users as a UTF-8 CSV file, when ?type=csv (served with that Content-Type).

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet — The Excel workbook, base64-encoded, when ?type=xlsx.

The users as a UTF-8 CSV file, when ?type=csv (served with that Content-Type).