Get bookmarks

This workflow sample demonstrates how to get a list of bookmarks from a shortcut object.

tip

You can try out this API with the REST API Playground

info

Obtain the authorization token needed to execute the request using POST /api/auth/login.

Get the project ID from GET /api/projects.

Get bookmarks

By using this workflow, you can quickly get a list of bookmarks from a shortcut object.

Request URL

GET /api/shortcuts/{shortcutId}/bookmarks

• shortcutId: The ID of the document shortcut to execute

Note: You can obtain the document shortcut instance ID from the URL. For example, if you open a dashboard and the URL is https://demo.microstrategy.com/MicroStrategyLibrary/app/EC70648611E7A2F962E90080EFD58751/316AAC7211EA8303102E0080EFA5E1BA then the instance ID is 316AAC7211EA8303102E0080EFA5E1BA.

Request Headers

Name	Type	Description
X-MSTR-AuthToken	Header	Authorization token generated by POST /api/auth/login
X-MSTR-ProjectID	Header	Project ID generated by GET /api/projects

Sample Curl Request

curl -X GET  'http://demo.microstrategy.com/MicroStrategyLibrary/api/shortcuts/E697E885F6426C1F0B794593D648AFC0/bookmarks' \
-H 'X-MSTR-AuthToken: h979btnpbep63peg8ind69ot79' \
-H 'X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754'

Response body schema

If successful, this request returns a 200 status code and a list of bookmarks.

[
  {
    "id": "string",
    "name": "string",
    "version": "string",
    "creationTime": "string",
    "lastUpdateTime": "string",
    "lastViewTime": "string",
    "href": "string",
    "shared": "boolean",
    "hidden": "boolean",
    "owner": {
      "id": "string",
      "name": "string",
      "expired": "boolean"
    }
  }
]

• id: Bookmark ID
• name: Bookmark name
• version: Bookmark version ID
• creationTime: Bookmark creation time in UTC
• lastUpdateTime: Bookmark last update time in UTC
• lastViewTime: Bookmark last view time in UTC
• href: Relative URL to get bookmark details
• shared: Bookmark has been shared to others
• hidden: Bookmark has been deleted by shared owner
• owner: Bookmark owner details
  • id: Owner ID
  • name: Owner name
  • expired: Owner expired

Sample response body

[
  {
    "name": "sample_name",
    "id": "sample_id",
    "version": "1",
    "creationTime": "2024-08-27T07:40:27.194Z",
    "lastUpdateTime": "2024-08-27T07:40:27.194Z",
    "lastViewTime": "2024-08-27T07:40:27.194Z",
    "href": "/relative/url",
    "shared": true,
    "hidden": true,
    "owner": {
      "name": "owner_name",
      "id": "owner_id",
      "expired": true
    }
  }
]

HTTP Status Codes

Status Code	Description
200	OK
500	Internal Server Error
401	Unauthorized
400	Bad Request