TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GET api/2.0/community/bookmark/{id} This function requires authentication

Description

Returns the detailed information on the bookmark with the ID specified in the request.

Parameters
Name Description Type Example
id
sent in url
Bookmark ID number 1234
Example
GET api/2.0/community/bookmark/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Bookmark information

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": "11",
    "Url": "http:\\/\\/www.google.com",
    "Thumbnail": "Url to thumbnail",
    "Created": "2020-12-06T07:36:14.8181893Z",
    "Updated": "2020-12-06T07:36:14.8181893Z",
    "Description": "Google",
    "CreatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Title": "Google inc."
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>11</Id>
    <Url>http:\/\/www.google.com</Url>
    <Thumbnail>Url to thumbnail</Thumbnail>
    <Created>2020-12-06T07:36:14.8181893Z</Created>
    <Updated>2020-12-06T07:36:14.8181893Z</Updated>
    <Description>Google</Description>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <Title>Google inc.</Title>
  </response>
</result>