Sigma REST APIWorkbooksbookmarks

List bookmarks in a workbook

View as Markdown
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
Unique identifier of the workbook.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldoubleOptional