getByStatus
EmployeeFullArrayWrapper getByStatus(status, filterBy, count, startIndex, sortBy, sortOrder, filterSeparator, filterValue)
GET /api/2.0/people/status/{status}
Get profiles by status
Returns a page of the accounts that are in one particular state - the status is taken from the route - with the full profile of each of them. The caller has to be a room admin, a DocSpace admin or a People module admin; a member or a guest gets 403. The call is read-only, paged by count and startIndex, ordered by sortBy and sortOrder, and reports the number of matches in the total count of the response. Narrow it with filterValue on the name and the email; setting filterBy to group makes the same filterValue the ID of the group to keep the members of, and because the value is then applied as the text filter as well, that combination normally matches nothing - use GET api/2.0/people/filter with groupId to filter by group. GET api/2.0/people is the same operation fixed to the Active status.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| status | path | EmployeeStatus | The account state to list, 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] |
| filterBy | query | String | The only recognised value is group, which makes filterValue the ID of the group to keep the members of. Any other value, and omitting the field, applies no group filter. | [optional] [example: group] |
| count | query | Integer (int32) | The size of the page. It defaults to 100, which is also the largest value the operation accepts. | [optional] [example: 25] [min: 1] [max: 100] |
| startIndex | query | Integer (int32) | The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response. | [optional] [example: 0] |
| sortBy | query | String | What to order the accounts by, compared without regard to case: FirstName, LastName, DisplayName, Type, Email, Department, UsedSpace, CreatedBy or RegistrationDate. | [optional] [example: DisplayName] |
| sortOrder | query | SortOrder | The direction of the ordering: Ascending, which is the default, or Descending. | [optional] [example: Ascending] [enum: 0, 1] |
| filterSeparator | query | String | The character that splits filterValue into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match. | [optional] [example: ,] |
| filterValue | query | String | The text to match against the name and the email of the account, case-insensitively. Omit it to apply no text filter. | [optional] [example: John] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | A page of accounts in the requested state, with their full profiles | EmployeeFullArrayWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | A parameter has the wrong type, or the count is outside its allowed range | - | - |
| 403 | The caller is a member or a guest | - | - |
| 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