GET /_system/users/search

Search system users (GET) with Elasticsearch query parameters

Search system users (GET) with Elasticsearch query parameters
KeyTypeExampleDescription
limitoptionalinteger
1
offsetoptionalinteger
1
Elasticsearch query offset parameter
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
{}
{
  "code": 401,
  "error": "INVALID_ACCESS_TOKEN"
}
StatusError CodeDescription
401INVALID_ACCESS_TOKENAuthentication required or invalid token
403INSUFFICIENT_PERMISSIONSInsufficient permissions for this operation
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
users_viewRequired scope: users_view

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