Get Started
Portal api methods
Help

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

Description

Returns a detailed information on the bookmark with the specified ID

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

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": 11,
    "title": "Google inc.",
    "url": "http:\/\/www.google.com",
    "thumbnail": "Url to thumbnail",
    "created": "2019-12-15T06:37:50.8054582Z",
    "updated": "2019-12-15T06:37:50.8054582Z",
    "description": "Google",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    }
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>11</id>
    <title>Google inc.</title>
    <url>http://www.google.com</url>
    <thumbnail>Url to thumbnail</thumbnail>
    <created>2019-12-15T06:37:50.8054582Z</created>
    <updated>2019-12-15T06:37:50.8054582Z</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></profileUrl>
    </createdBy>
  </response>
</result>