Get Started
Usage API
More information

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

Description

Returns a list of users matching the status filter and search query.

Parameters
Name Description Type Example
status
sent in url
User status Active, Terminated, LeaveOfAbsence, Default, All
query
sent in url
Search query string some text
Example
GET api/2.0/people/status/active/search?query=some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of users

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": "2021-10-19T03:55:35.8508565Z",
      "sex": "male",
      "status": 1,
      "activationStatus": 0,
      "terminated": null,
      "department": "Marketing",
      "workFrom": "2021-10-19T03:55:35.8508565Z",
      "location": "Palo Alto",
      "notes": "Notes to worker",
      "displayName": null,
      "title": "Manager",
      "contacts": [
        {
          "type": "GTalk",
          "value": "my@gmail.com"
        }
      ],
      "groups": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Group Name",
          "manager": "Jake.Zazhitski"
        }
      ],
      "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": ""
    }
  ]
}

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>2021-10-19T03:55:35.8508565Z</birthday>
    <sex>male</sex>
    <status>1</status>
    <activationStatus>0</activationStatus>
    <terminated />
    <department>Marketing</department>
    <workFrom>2021-10-19T03:55:35.8508565Z</workFrom>
    <location>Palo Alto</location>
    <notes>Notes to worker</notes>
    <displayName />
    <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>
    <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></profileUrl>
  </response>
</result>