searchUsersByStatus
EmployeeFullArrayWrapper searchUsersByStatus(status, query, filterBy, filterValue)
GET /api/2.0/people/status/{status}/search
Search users by status filter
Searches the accounts that are in one particular state - the status is taken from the route - and whose name, user name, email or contacts contain the search term. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. The call is read-only and is not paged: it matches in memory over every account of that status and streams all of them, so it is meant for administrative lookups rather than for a user-facing list - use GET api/2.0/people/filter when a page and a total are needed. The term is matched as a case-insensitive substring and is required; filterBy set to group turns text into a group ID and keeps only the members of that group, so text then has to be a valid identifier. The answer holds full profiles, in no particular order.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| status | path | EmployeeStatus | The account state to search in, taken from the route: Active for working accounts, Terminated for disabled ones, Pending for open invitations, or All for every state. | [required] [example: Active] [enum: 1, 2, 4, 5, 7] |
| query | query | String | The term to look for, matched as a case-insensitive substring of the first name, the last name, the user name, the email and the contacts. It is required in practice, because the search cannot run without it. | [optional] [example: John] |
| filterBy | query | String | The only recognised value is group, which turns filterValue into a group ID and keeps only the members of that group. Any other value, and omitting the field, applies no group filter. | [optional] [example: group] |
| filterValue | query | String | The group ID to keep the members of, used only when filterBy is group. It has to be a valid identifier - a group name is not accepted. | [optional] [example: 00000000-0000-0000-0000-000000000000] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The full profiles of the matching accounts | EmployeeFullArrayWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | A parameter has the wrong type, or query is missing | - | - |
| 403 | The caller is not a DocSpace administrator | - | - |
| 500 | The filterBy is group and the filterValue is not a GUID | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json