List bookmarks in a workbook

GET

/v2/workbooks/:workbookId/bookmarks

Returns a list of available bookmarks in a workbook. Available bookmarks are those that you have created or that have been shared with you.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.

Usage scenarios

Maintenance and governance: Review workbook bookmarks for usage, validity, and freshness.

Returns a list of available bookmarks in a workbook. Available bookmarks are those that you have created or that have been shared with you. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Maintenance and governance**: Review workbook bookmarks for usage, validity, and freshness.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional

limitdoubleOptional

Response

The response body.

entrieslist of objects

nextPagestring or null

totaldouble

1	{
2	"entries": [
3	{
4	"bookmarkId": "bkmk-9f8e7d6c5b4a3e2f1d0c",
5	"name": "Q1 Sales Overview",
6	"isShared": true,
7	"exploreKey": "explore-12345abcde",
8	"isDefault": false
9	},
10	{
11	"bookmarkId": "bkmk-1a2b3c4d5e6f7g8h9i0j",
12	"name": "Marketing Campaign Analysis",
13	"isShared": false,
14	"exploreKey": "explore-67890fghij",
15	"isDefault": true
16	}
17	],
18	"nextPage": "eyJwYWdlIjoiMg==",
19	"total": 2
20	}

$	curl https://api.sigmacomputing.com/v2/workbooks/workbookId/bookmarks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"