GET api/2.0/people/filter This function requires authentication

Description

Returns a list of users with full information about them matching the parameters specified in the request.

Parameters

Name	Description	Type	Example
employeeStatus sent in body	User status optional	Active, Terminated, LeaveOfAbsence, Default, All	Active
groupId sent in body	Group ID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
activationStatus sent in body	Activation status optional	NotActivated, Activated, Pending, AutoGenerated	NotActivated
employeeType sent in body	User type optional	All, RoomAdmin, User, DocSpaceAdmin, Collaborator	All
isAdministrator sent in body	Specifies if the user is an administrator or not optional	Bool value	true
payments sent in body	User payment status optional	Paid, Free	Paid

Example

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",
  "isAdministrator": true,
  "payments": "Paid"
}

Returns

List of users with the detailed information