# Bookmark API

Information noteIf you are using Qlik Sense Business or Qlik Sense Enterprise SaaS, see the API documentation at the Qlik ([Developer Portal](https://qlik.dev/)).

Information note**STABLE.**   
  
This API is reliable and breaking changes are unlikely.

qlik.app.bookmark

The Bookmark API contains methods to work with bookmarks on the Qlik Sense app you are connected to.



## Version history

Each method and property contain information around when it was introduced, updated, deprecated or removed. A list of all relevant API changes per version release can be found in [API version history](https://help.qlik.com/en-US/sense-developer/May2025/Content/Sense_Helpsites/api-version-history.htm).

Version history

| Version state | Details |
| --- | --- |
| Introduced | 1.0 |

## Getting started

You must connect to the Qlik Sense app before applying existing, or creating new, bookmarks. You do this with the qlik.openApp method.

```
var config = {
	host: 'QSE_domain',
	prefix: '/',
	port: 443,
	isSecure: true
};
require(["js/qlik"], function(qlik) {
  //open apps -- inserted here --
  var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
  //apply a bookmark
  app.bookmark.apply('pPvpTN');
}
```

## Examples of use

Learn what you can do with the Bookmark API.

### Create a new bookmark based on current selection

Use the qlik.app.bookmark.create method to create a bookmark based on the current selection.

```
require(["js/qlik"], function(qlik) {
  //open apps -- inserted here --
  var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
  //create a bookmark
  app.bookmark.create('Test','Test bookmark','fmcJkH');
}
```

### Apply an existing bookmark

Use the qlik.app.bookmark.apply method to apply an existing bookmark.

```
var config = {
	host: 'QSE_domain',
	prefix: '/',
	port: 443,
	isSecure: true
};
require(["js/qlik"], function(qlik) {
  //open apps -- inserted here --
  var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
  //apply a bookmark
  app.bookmark.apply('pPvpTN');
}
```

### Remove a bookmark that you have applied

Use the qlik.app.bookmark.remove method to remove an existing bookmark.

```
var config = {
	host: 'QSE_domain',
	prefix: '/',
	port: 443,
	isSecure: true
};
require(["js/qlik"], function(qlik) {
  //open apps -- inserted here --
  var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
  //remove a bookmark
  app.bookmark.remove('pPvpTN');
}
```