TRY NEW VERSION

GET api/2.0/community/bookmark/bytag This function requires authentication

Description

Returns a list of all the bookmarks marked by the tag specified in the request with the bookmark titles, dates of creation and update, bookmark texts, and authors.

Parameters
Name Description Type Example
tag
sent in url
Tag name string some text
Example
GET api/2.0/community/bookmark/bytag?tag=%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of bookmarks

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>