---
title: "Get embeds for a workbook"
method: GET
path: "/v2/workbooks/{workbookId}/embeds"
tags: ["Workbooks"]
---

# Get embeds for a workbook

`GET /v2/workbooks/{workbookId}/embeds`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workbooks/{workbookId}/embeds`
- Auth: HTTP bearer

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.

## Path parameters

- `workbookId` string, required

## Query parameters

- `page` string
- `limit` number, double

## Response `200`

The response body.

- WorkbooksListWorkbookEmbedsResponse200
  - `entries` V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `embedId` string, required: Unique identifier of the embed.
    - `embedUrl` string, required
    - `public` boolean, required
    - `sourceType` 'workbook' | 'page' | 'element', required
    - `sourceId` string, nullable, required
    - `sourceName` string, nullable, required
  - `nextPage` string, nullable, required: 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`.
  - `total` number, double: Total number of results. Useful to determine if there is a need to paginate.
  - `hasMore` boolean: **[Deprecated]** Indicates whether more results are available.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)