Loading ...

REST API: Get My Bookmarks | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Bookmarks » REST API: Get My Bookmarks
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get My Bookmarks

0 
 /5
0 (0votes)

Get My Bookmarks

GET  /api/content/bookmarks

Allows a member to get their bookmarks. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
PageLength &pagelength=x - Used in the request URL (see below) Specifies the number of results to be returned per page.
StartPage &startpage=x - Used in the request URL (see below) Specifies the starting page of the list to be returned.

Example URL: https://your-community.com/api/content/bookmarks?startpage=1&pagelength=100

Response JSON sample where bookmarks JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
   {
    "BookmarkID": 2,
    "EntityID": 1084,
    "EntityType": 14,
    "SpaceID": 2,
    "Url": "https://your-community.com/spaces/2/private-space/files/1084/file-jpeg",
    "UserID": 11,
    "DateCreated": "2019-06-29T17:49:29.937",
    "SortOrder": 0,
    "Title": "file.jpeg",
    "Description": "File",
    "IsExternal": false,
    "BookmarkEntityIconCssClass": "icon-folder-open",
    "TenantID": 0
   }
  ],
}

Please Note Your content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software