POST /users/search

Search users using request body parameters

Search users using request body parameters
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
KeyTypeExampleDescription
countoptionalboolean
4
Return count instead of results
filtersoptionalobject
{}
Additional search filters
limitoptionalinteger
50
Maximum number of results
offsetoptionalinteger
0
Number of results to skip
queryoptionalstring
"example"
Search query string
sortoptionalarray
[{}]
{}
{
  "error": "ERROR_KEY"
}
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
users_searchRequired scope: users_search
setting_manage_usersAdditional permission check: setting_manage_users

Back to Users Return to the Users category to view other endpoints All API Categories Browse all available API categories