GET api/2.0/people/status/{status} This function requires authentication

Description

Returns a list of profiles filtered by user status.

Parameters
Name Description Type Example
status
sent in url
User status ("Active", "Terminated", "LeaveOfAbsence", "All", or "Default") Active, Terminated, LeaveOfAbsence, Default, All Active
Example
GET api/2.0/people/status/{status}
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "status": "Active"
}
Returns

List of profiles

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "UserName": "Mike.Zanyatski",
      "IsVisitor": false,
      "FirstName": "Mike",
      "LastName": "Zanyatski",
      "Email": "my@domain.com",
      "Birthday": "2008-04-10T06-30-00.000Z",
      "Sex": "male",
      "Status": 1,
      "ActivationStatus": 0,
      "Terminated": "2008-04-10T06-30-00.000Z",
      "Department": "Marketing",
      "WorkFrom": "2008-04-10T06-30-00.000Z",
      "Location": "Palo Alto",
      "Notes": "Notes to worker",
      "DisplayName": "Mike Zanyatski",
      "MobilePhone": "MobilePhone",
      "MobilePhoneActivationStatus": "1",
      "Title": "Manager",
      "Contacts": {
        "Type": "GTalk",
        "Value": "my@gmail.com"
      },
      "Groups": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Group Name",
        "Manager": "Jake.Zazhitski"
      },
      "Lead": "055312F1-1D71-4786-BB5B-D5910316E53C",
      "AvatarMedium": "url to medium avatar",
      "Avatar": "url to big avatar",
      "IsAdmin": false,
      "IsLDAP": false,
      "ListAdminModules": [
        "projects",
        "crm"
      ],
      "IsOwner": false,
      "CultureName": "en-EN",
      "IsSSO": false,
      "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>
    <UserName>Mike.Zanyatski</UserName>
    <IsVisitor>False</IsVisitor>
    <FirstName>Mike</FirstName>
    <LastName>Zanyatski</LastName>
    <Email>my@domain.com</Email>
    <Birthday>2008-04-10T06-30-00.000Z</Birthday>
    <Sex>male</Sex>
    <Status>1</Status>
    <ActivationStatus>0</ActivationStatus>
    <Terminated>2008-04-10T06-30-00.000Z</Terminated>
    <Department>Marketing</Department>
    <WorkFrom>2008-04-10T06-30-00.000Z</WorkFrom>
    <Location>Palo Alto</Location>
    <Notes>Notes to worker</Notes>
    <DisplayName>Mike Zanyatski</DisplayName>
    <MobilePhone>MobilePhone</MobilePhone>
    <MobilePhoneActivationStatus>1</MobilePhoneActivationStatus>
    <Title>Manager</Title>
    <Contacts>
      <Type>GTalk</Type>
      <Value>my@gmail.com</Value>
    </Contacts>
    <Groups>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Name>Group Name</Name>
      <Manager>Jake.Zazhitski</Manager>
    </Groups>
    <Lead>055312F1-1D71-4786-BB5B-D5910316E53C</Lead>
    <AvatarMedium>url to medium avatar</AvatarMedium>
    <Avatar>url to big avatar</Avatar>
    <IsAdmin>False</IsAdmin>
    <IsLDAP>False</IsLDAP>
    <ListAdminModules>projects</ListAdminModules>
    <ListAdminModules>crm</ListAdminModules>
    <IsOwner>False</IsOwner>
    <CultureName>en-EN</CultureName>
    <IsSSO>False</IsSSO>
    <AvatarSmall>url to small avatar</AvatarSmall>
    <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
  </response>
</result>