Returns a list of users with full information about them matching the parameters specified in the request.
Name | Description | Type | Example |
employeeStatus
sent in url
|
User status
optional
|
Active, Terminated, LeaveOfAbsence, Default, All | Active |
groupId
sent in url
|
Group ID
optional
|
guid | 9924256A-739C-462b-AF15-E652A3B1B6EB |
activationStatus
sent in url
|
Activation status
optional
|
NotActivated, Activated, Pending, AutoGenerated | NotActivated |
employeeType
sent in url
|
User type
optional
|
All, RoomAdmin, User, DocSpaceAdmin, Collaborator | All |
employeeTypes
sent in url
|
List of user types | ASC.Core.Users.EmployeeType[] | |
isAdministrator
sent in url
|
Specifies if the user is an administrator or not
optional
|
Bool value | true |
payments
sent in url
|
User payment status
optional
|
Paid, Free | Paid |
accountLoginType
sent in url
|
Account login type
optional
|
ASC.Core.AccountLoginType | |
quotaFilter
sent in url
|
Filter by quota (Default - 1, Custom - 2)
optional
|
ASC.Core.QuotaFilter | |
withoutGroup
sent in url
|
Specifies whether the user should be a member of a group or not
optional
|
Bool value | true |
excludeGroup
sent in url
|
Specifies whether or not the user should be a member of the group with the specified ID
optional
|
Bool value | true |
GET api/2.0/people/filter Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json { "employeeStatus": "Active", "groupId": "9924256A-739C-462b-AF15-E652A3B1B6EB", "activationStatus": "NotActivated", "employeeType": "All", "employeeTypes": [ "All" ], "isAdministrator": true, "payments": "Paid", "accountLoginType": null, "quotaFilter": null, "withoutGroup": true, "excludeGroup": true }
List of users with the detailed information
{ "status": 0, "response": [ { "FirstName": "some text", "LastName": "some text", "UserName": "some text", "Email": "some text", "Birthday": "2008-04-10T06-30-00.000Z", "Sex": "some text", "Status": "Active", "ActivationStatus": "NotActivated", "Terminated": "2008-04-10T06-30-00.000Z", "Department": "some text", "WorkFrom": "2008-04-10T06-30-00.000Z", "Location": "some text", "Notes": "some text", "AvatarOriginal": "some text", "AvatarMax": "some text", "AvatarMedium": "some text", "Avatar": "some text", "IsAdmin": true, "IsRoomAdmin": true, "IsLDAP": true, "ListAdminModules": [ "some text" ], "IsOwner": true, "IsVisitor": true, "IsCollaborator": true, "CultureName": "some text", "MobilePhone": "some text", "MobilePhoneActivationStatus": "NotActivated", "IsSSO": true, "QuotaLimit": 1234, "UsedSpace": 1234, "IsCustomQuota": true } ] }