GET /users/search

Search users (query) with Elasticsearch query parameters

Search users (query) with Elasticsearch query parameters
KeyTypeExampleDescription
offsetoptionalinteger
1
Elasticsearch query offset parameter
limitoptionalinteger
1
Elasticsearch query limit parameter
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
{}
{
  "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