List elements in a workbook

View as MarkdownOpen in Claude
This endpoint retrieves all elements in a workbook, which lets you understand and interact with the individual components that make up the workbook, such as charts, tables, or controls. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - To retrieve elements from version-tagged workbooks, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve elements from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints. ### Usage scenarios - **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation. - **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with. ### Best practices - Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience. - Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional
limitdoubleOptional
tagNamestringOptional
bookmarkIdstringOptional

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldouble