Search users

Search for one or more users.

Metadata
search.user_id
array of strings

Query by user identifier.

search.user_id
search.agent_id
array of strings

Query by agents

search.agent_id
search.customer_hierarchy_id
array of strings

Query by customer hierarchies

search.customer_hierarchy_id
search.login
array of strings

Query by all or part of login/username.

search.login
search.first_name
array of strings

Query by all or part of first name.

search.first_name
search.last_name
array of strings

Query by all or part of last name.

search.last_name
search.email
array of strings

Query by all or part of email.

search.email
boolean

Return when Null: All; when True: Only Active; when False: Only Inactive.

date-time

Query by created date.

date-time

Query by created date.

int32

Defines how many items to return at a time.

int32

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

string

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html