Get Started
Usage API
More information

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 body
User ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
Example
GET api/2.0/portal/users/{userid}
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userID": "9924256A-739C-462b-AF15-E652A3B1B6EB"
}
Returns

User

Example Response

application/json

{
  "status": 0,
  "response": {
    "ID": "38c0f464-f1e7-493e-8d95-dc4ee8ee834a",
    "FirstName": "FirstName",
    "LastName": "LastName",
    "UserName": "UserName",
    "BirthDate": "2019-07-26T00:00:00",
    "Sex": true,
    "Status": 1,
    "ActivationStatus": 1,
    "TerminatedDate": "2019-07-26T00:00:00",
    "Title": "Title",
    "WorkFromDate": "2019-07-26T00:00:00",
    "Email": "Email",
    "Contacts": [
      "Contacts"
    ],
    "Location": "Location",
    "Notes": "Notes",
    "Removed": false,
    "LastModified": "2019-07-26T00:00:00",
    "Tenant": 1,
    "IsActive": false,
    "CultureName": "CultureName",
    "MobilePhone": "MobilePhone",
    "MobilePhoneActivationStatus": 1,
    "Sid": "Sid",
    "SsoNameId": "SsoNameId",
    "SsoSessionId": "SsoSessionId",
    "CreateDate": "2019-07-26T00:00:00"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <ID>38c0f464-f1e7-493e-8d95-dc4ee8ee834a</ID>
    <FirstName>FirstName</FirstName>
    <LastName>LastName</LastName>
    <UserName>UserName</UserName>
    <BirthDate>2019-07-26T00:00:00</BirthDate>
    <Sex>True</Sex>
    <Status>1</Status>
    <ActivationStatus>1</ActivationStatus>
    <TerminatedDate>2019-07-26T00:00:00</TerminatedDate>
    <Title>Title</Title>
    <WorkFromDate>2019-07-26T00:00:00</WorkFromDate>
    <Email>Email</Email>
    <Contacts>Contacts</Contacts>
    <Location>Location</Location>
    <Notes>Notes</Notes>
    <Removed>False</Removed>
    <LastModified>2019-07-26T00:00:00</LastModified>
    <Tenant>1</Tenant>
    <IsActive>False</IsActive>
    <CultureName>CultureName</CultureName>
    <MobilePhone>MobilePhone</MobilePhone>
    <MobilePhoneActivationStatus>1</MobilePhoneActivationStatus>
    <Sid>Sid</Sid>
    <SsoNameId>SsoNameId</SsoNameId>
    <SsoSessionId>SsoSessionId</SsoSessionId>
    <CreateDate>2019-07-26T00:00:00</CreateDate>
  </response>
</result>