Get paginated list of users

Get paginated list of users

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Company ID

string

External account ID: this is a composite key made up of the origin and externalAccountId, in the format "origin-externalAccountId" (e.g., wrike-6637378)

uuid

Organization ID

enum

Filter to retrieve users with a license if set to true, or without a license if set to false

string

Search users by firstname, lastname, email or domain

string

Filter users by role: "user" for regular users, "organization-admin" for users with admin rights in their organization, or "company-admin" for users with admin rights in their company and associated organizations

string
Defaults to +email

Sorting criteria, e.g., "+email" for ascending or "-createdAt" for descending

string
Defaults to initialized,confirmed,completed

Filter users by their status ("initialized", "confirmed", "completed", "deactivated"). "initialized" = just created, "confirmed" = with confirmed email, "completed" = ready to fully use Klaxoon. Some statuses imply others : "anonymized" implies "deactivated", "completed" implies "initialized" and "confirmed", "confirmed" implies "initialized".

number
≥ 1
Defaults to 1

Page number

number | null
0 to 100
Defaults to 20

Maximum results per page

string | null

Include fields

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json