Get Started
API backend
API system
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 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

application/json

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

text/xml

<result>
  <status>0</status>
  <response>
    <Id>9924256A-739C-462b-AF15-E652A3B1B6EB</Id>
    <FirstName>some text</FirstName>
    <LastName>some text</LastName>
    <UserName>some text</UserName>
    <Status>Active</Status>
    <ActivationStatus>NotActivated</ActivationStatus>
    <Title>some text</Title>
    <Email>some text</Email>
    <Contacts>some text</Contacts>
    <ContactsList>[
  "some text"
]</ContactsList>
    <Location>some text</Location>
    <Notes>some text</Notes>
    <Removed>True</Removed>
    <LastModified>2008-04-10T06-30-00.000Z</LastModified>
    <Tenant>1234</Tenant>
    <IsActive>True</IsActive>
    <CultureName>some text</CultureName>
    <MobilePhone>some text</MobilePhone>
    <Sid>some text</Sid>
    <LdapQouta>1234</LdapQouta>
    <SsoNameId>some text</SsoNameId>
    <SsoSessionId>some text</SsoSessionId>
    <CreateDate>2008-04-10T06-30-00.000Z</CreateDate>
  </response>
</result>