POST /users/search
Search users using request body parameters
/users/search
POST
Search users using request body parameters
| Key | Type | Example | Description |
|---|---|---|---|
| authorization required | string |
"Bearer access_token"
|
Access token
|
| Key | Type | Example | Description |
|---|---|---|---|
| query optional | string |
"example-string"
|
Search query string
|
| count optional | boolean |
true
|
Return count instead of results
|
| limit optional | integer |
50
|
Maximum number of results
|
| offset optional | integer |
0
|
Number of results to skip
|
| filters optional | object |
{}
|
Additional search filters
|
| sort optional | array |
[{}]
|
{}
{
"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