Get Started
Portal api methods
Help

GET api/2.0/community/bookmark/@search/{query} This function requires authentication

Description

Returns a list of bookmarks matching the search query with the bookmark title, date of creation and update, bookmark description and author

Parameters
Name Description Type Example
query
sent in url
search query string some text
Example
GET api/2.0/community/bookmark/@search/some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of bookmarks

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "id": 11,
      "title": "Google inc.",
      "url": "http:\/\/www.google.com",
      "thumbnail": "Url to thumbnail",
      "created": "2019-08-19T01:39:25.4011642Z",
      "updated": "2019-08-19T01:39:25.4011642Z",
      "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-08-19T01:39:25.4011642Z</created>
    <updated>2019-08-19T01:39:25.4011642Z</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>