v1
latestOpenAPI 3.0.02026-07-263403911.5 MBUsers
Search users
Search for one or more users.
get/v1/Users
Query parameters
search.user_idstring[]
Query by user identifier.
search.agent_idstring[]
Query by agents
search.customer_hierarchy_idstring[]
Query by customer hierarchies
search.loginstring[]
Query by all or part of login/username.
search.first_namestring[]
Query by all or part of first name.
search.last_namestring[]
Query by all or part of last name.
search.emailstring[]
Query by all or part of email.
search.activeboolean
Return when Null: All; when True: Only Active; when False: Only Inactive.
search.created_date_startstring date-time
Query by created date.
search.created_date_endstring date-time
Query by created date.
search.page_sizeinteger
Defines how many items to return at a time.
search.pageinteger
Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)
search.sortstring
Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.
Response
OK