Search Users

post

https://{domain}/api/v4/users

Body Params

The input.

sorting

string

enum

Sorting

Members:

Ascending - Ascending from A-Z
Descending - Descending from Z-A

Allowed:

pageNumber

int32 | null

1 to 10000

Page number

pageSize

int32 | null

1 to 100

Page size

orderBy

string

enum

UsersOrder

Members:

Name - Order by name
Email - Order by email
Created - Order by created

Allowed:

companyId

int32 | null

Search for users by company id

teamId

int32 | null

Search for users by team id

string | null

Search for users by email address

textSearch

string | null

Search for users by text

exactRole

string

enum

Role

Members:

Anonymous - Everyone
Subscriber - Subscriber
Employee - Employee
Manager - Manager
Administrator - Administrator

Allowed:

minimumRole

string

enum

Role

Members:

Anonymous - Everyone
Subscriber - Subscriber
Employee - Employee
Manager - Manager
Administrator - Administrator

Allowed:

roles

array of objects | null

Search users by specific role

roles

lastLoginDate

date-time | null

Search users by last login date

phone

string | null

Search for users by phone number

acceptedInvitation

boolean | null

Search for users that accepted the invitation

phoneVerified

boolean | null

Search for users that have verified the phone number

Responses

401

Unauthorized

403

Forbidden

405

NotAllowed

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success