searchUsersByExtendedFilter
EmployeeFullArrayWrapper searchUsersByExtendedFilter(employeeStatus, groupId, activationStatus, employeeType, employeeTypes, isAdministrator, payments, accountLoginType, quotaFilter, withoutGroup, excludeGroup, invitedByMe, inviterId, area, count, startIndex, sortBy, sortOrder, filterSeparator, filterValue)
GET /api/2.0/people/filter
Filter users in detail
Returns a page of portal accounts selected by the full set of account filters, with the complete 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, and a DocSpace admin additionally sees the accounts an ordinary admin does not. 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. Filters combine as conditions that all have to hold, with three interactions worth knowing: withoutGroup makes groupId irrelevant, employeeType wins over employeeTypes when both are sent, and area set to Guests or People cancels the type filters that contradict it. GET api/2.0/people/simple/filter accepts exactly the same filters and returns the short profile instead, so use that one for pickers and lists and this one when the full profile is really needed. It is available on an unpaid portal.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| employeeStatus | query | EmployeeStatus | Keeps only the accounts in the given state: Active for working accounts, Terminated for disabled ones and Pending for open invitations. Omit it to search every state. | [optional] [example: Active] [enum: 1, 2, 4, 5, 7] |
| groupId | query | UUID (uuid) | Keeps only the members of this group, or excludes them when excludeGroup is true. It is ignored when withoutGroup is set. | [optional] [example: 00000000-0000-0000-0000-000000000000] |
| activationStatus | query | EmployeeActivationStatus | Keeps only the accounts whose activation is in the given state: NotActivated, Activated, Pending or AutoGenerated. Omit it to search every state. | [optional] [example: Activated] [enum: 0, 1, 2, 4] |
| employeeType | query | EmployeeType | Keeps only the accounts of this single type: DocSpaceAdmin, RoomAdmin, User or Guest. When it is sent it wins over employeeTypes, and a type that contradicts area is dropped. | [optional] [example: RoomAdmin] [enum: All, RoomAdmin, Guest, DocSpaceAdmin, User] |
| employeeTypes | query | List | Keeps the accounts of any of the listed types, combined as alternatives. It is ignored when employeeType is also sent. | [optional] [example: ["RoomAdmin","Guest"]] [enum: 0, 1, 2, 3, 4] |
| isAdministrator | query | Boolean | Set it to true to keep only the DocSpace administrators and the module administrators. Setting it to false is the same as omitting it and does not exclude administrators. | [optional] [example: false] |
| payments | query | Payments | Keeps only the accounts that take a paid seat when Paid, or only the guests and members that do not when Free. Omit it to search both. | [optional] [example: Paid] [enum: 0, 1] |
| accountLoginType | query | AccountLoginType | Keeps only the accounts that sign in this way: SSO, LDAP, or Standart for an ordinary portal password. Omit it to search all of them. | [optional] [example: Standart] [enum: 0, 1, 2] |
| quotaFilter | query | QuotaFilter | Keeps only the accounts whose storage quota is the portal default when Default, or set individually when Custom. All, which is the same as omitting the field, searches both. | [optional] [example: Custom] [enum: 0, 1, 2] |
| withoutGroup | query | Boolean | Set it to true to keep only the accounts that belong to no group at all, which makes groupId and excludeGroup irrelevant. | [optional] [example: false] |
| excludeGroup | query | Boolean | Inverts groupId: with true the members of that group are left out instead of being the only ones kept. It has no effect without groupId. | [optional] [example: false] |
| invitedByMe | query | Boolean | Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation. | [optional] [example: false] |
| inviterId | query | UUID (uuid) | Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation. | [optional] [example: 00000000-0000-0000-0000-000000000000] |
| area | query | AccountSearchArea | The part of the portal to search in: All, the default, searches members and guests together, People leaves the guests out, and Guests returns guests only. It also cancels the type filters that contradict it. | [optional] [example: All] [enum: 0, 1, 2] |
| 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 first name, the last name and the email, case-insensitively. Omit it to apply no text filter at all. | [optional] [example: John] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | A page of matching accounts, 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 | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 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