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 url	User status ("Active", "Terminated", "LeaveOfAbsence", "All", or "Default") 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 ("NotActivated", "Activated", "Pending", or "AutoGenerated") optional	NotActivated, Activated, Pending, AutoGenerated	NotActivated
employeeType sent in url	User type ("All", "User", or "Visitor") optional	All, User, Visitor	All
isAdministrator sent in url	Specifies if the user is an administrator or not optional	Bool value	true

Example

GET api/2.0/people/filter?employeeStatus=%22Active%22&groupId=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&activationStatus=%22NotActivated%22&employeeType=%22All%22&isAdministrator=true
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of users with their information

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <DisplayName>Mike Zanyatski</DisplayName>
    <Title>Manager</Title>
    <AvatarSmall>url to small avatar</AvatarSmall>
    <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
  </response>
</result>