RUAL Documentation

GET /users/search

Search users (query) with Elasticsearch query parameters

Search users (query) with Elasticsearch query parameters
Key Type Example Description
offset optional integer
42
Elasticsearch query offset parameter
limit optional integer
42
Elasticsearch query limit parameter
Key Type Example Description
authorization required string
"Bearer access_token"
Access token
{}
{ "error": "ERROR_KEY" }
Permission Description
Bearer token Access token required via Authorization header, x-authtoken, x-token, query param, or cookie
users_search Required scope: users_search
setting_manage_users Additional 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