Search Users

Search for users across both agents and end users in a single request. The search text is matched against the user name, first name, last name, email address and cell phone number. By default both agents and end users are searched; use the userType parameter to narrow the search to one of them. Searching agents, or agents and end users together, requires the SysAdmin permission. Searching end users only also allows a users manager. Otherwise, the request is rejected with a 403 error.

Query Params
string
required
length between 1 and 500

The text to search for. The text is matched against the user name, first name, last name, email address and cell phone number.

string
enum

Filter results by user type. When omitted, both agents and end users are searched.

Allowed:
integer
1 to 500
Defaults to 20

The number of items to return per page. The default is 20, and you can have up to 500.

integer
≥ 0
Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

Responses

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