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

Description

Returns a list of users matching the parameters specified in the request.

Parameters
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
Example
GET api/2.0/people/simple/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
}
Returns

List of users

Example Response
{
  "status": 0,
  "response": [
    {
      "Id": "9924256A-739C-462b-AF15-E652A3B1B6EB",
      "DisplayName": "some text",
      "Title": "some text",
      "AvatarSmall": "some text",
      "ProfileUrl": "some text",
      "HasAvatar": true
    }
  ]
}