Get embeds for a workbook

View as MarkdownOpen in Claude
This endpoint retrieves the list of available embeds for a specific workbook. The response provides the embedUrl and indicates whether an embed is public. ### Usage notes - The endpoint requires the `workbookId` as a path parameter to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Integration with third-party applications:** Developers can use this endpoint to list embeds that integrate workbook content into third-party applications, enhancing functionality or providing customized views. - **Internal dashboards:** Teams within an organization can embed workbook content into internal dashboards to monitor real-time data and analytics from various workbooks without directly accessing Sigma. ### Best practices - Ensure that the embeds are used in compliance with data governance and privacy policies. - Regularly review and manage the access permissions for each embed to prevent unauthorized data exposure.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional
limitdoubleOptional

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldouble
Total number of results. Useful to determine if there is a need to paginate.
hasMoreboolean

[Deprecated] Indicates whether more results are available.