TRY NEW VERSION

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

Description

Returns a list of users matching the search query.

Parameters
Name Description Type Example
query
sent in url
Search query string some text
Example
GET api/2.0/people/@search/%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of users with the detailed information

Example Response
{
  "status": 0,
  "response": [
    {
      "FirstName": "some text",
      "LastName": "some text",
      "UserName": "some text",
      "Email": "some text",
      "Birthday": "2008-04-10T06-30-00.000Z",
      "Sex": "some text",
      "Status": "Active",
      "ActivationStatus": "NotActivated",
      "Terminated": "2008-04-10T06-30-00.000Z",
      "Department": "some text",
      "WorkFrom": "2008-04-10T06-30-00.000Z",
      "Location": "some text",
      "Notes": "some text",
      "AvatarOriginal": "some text",
      "AvatarMax": "some text",
      "AvatarMedium": "some text",
      "Avatar": "some text",
      "IsAdmin": true,
      "IsRoomAdmin": true,
      "IsLDAP": true,
      "ListAdminModules": [
        "some text"
      ],
      "IsOwner": true,
      "IsVisitor": true,
      "IsCollaborator": true,
      "CultureName": "some text",
      "MobilePhone": "some text",
      "MobilePhoneActivationStatus": "NotActivated",
      "IsSSO": true,
      "QuotaLimit": 1234,
      "UsedSpace": 1234,
      "IsCustomQuota": true
    }
  ]
}