TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GET api/2.0/portal/users/{userID} This function requires authentication

Description

Returns a user with the ID specified in the request from the current portal.

Parameters
Name Description Type Example
userID
sent in url
User ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
Example
GET api/2.0/portal/users/%229924256A-739C-462b-AF15-E652A3B1B6EB%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

User information

Example Response
{
  "status": 0,
  "response": {
    "Id": "9924256A-739C-462b-AF15-E652A3B1B6EB",
    "FirstName": "some text",
    "LastName": "some text",
    "UserName": "some text",
    "BirthDate": "2008-04-10T06-30-00.000Z",
    "Sex": true,
    "Status": "Active",
    "ActivationStatus": "NotActivated",
    "TerminatedDate": "2008-04-10T06-30-00.000Z",
    "Title": "some text",
    "WorkFromDate": "2008-04-10T06-30-00.000Z",
    "Email": "some text",
    "Contacts": "some text",
    "ContactsList": [
      "some text"
    ],
    "Location": "some text",
    "Notes": "some text",
    "Removed": true,
    "LastModified": "2008-04-10T06-30-00.000Z",
    "TenantId": 1234,
    "IsActive": true,
    "CultureName": "some text",
    "MobilePhone": "some text",
    "MobilePhoneActivationStatus": "NotActivated",
    "Sid": "some text",
    "LdapQouta": 1234,
    "SsoNameId": "some text",
    "SsoSessionId": "some text",
    "CreateDate": "2008-04-10T06-30-00.000Z"
  }
}