Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Keyword to search for in user information such as displayName, profileHandle, and userId. The search is case-insensitive and supports partial matches.
Maximum length:
100
Return exact match search result when true
Filter users either by all users or only flagged users
Available options:
all
, flagged
Sort users by specified criteria default to displayName
.
Available options:
firstCreated
, lastCreated
, displayName
, profileHandle
Fields to search users for the keyword (must be used with a keyword parameter), Default is all three fields <br>
displayName
- Search by display name. When using withsortBy
parameter the applicable sort order isdisplayName
,lastCreated
orfirstCreated
. Default todisplayName
.<br>profileHandle
- Search by profile handle, when using withsortBy
parameter the applicable sort order isprofileHandle
,lastCreated
orfirstCreated
. Default toprofileHandle
. <br>userId
- Search by user id, when using withsortBy
parameter the applicable sort order islastCreated
,firstCreated
ordisplayName
. Default todisplayName
.<br> Default is all three fields
Maximum length:
3
Number of results per page (1-100)
Required range:
1 <= x <= 100
Pagination token for getting next/previous pages
Maximum length:
100
filter only deleted users when true