---
title: "List elements in a workbook page"
method: GET
path: "/v2/workbooks/{workbookId}/pages/{pageId}/elements"
tags: ["Workbooks"]
---

# List elements in a workbook page

`GET /v2/workbooks/{workbookId}/pages/{pageId}/elements`

## Request

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

This endpoint retrieves all elements from a specific page within a workbook, which lets you understand and interact with the individual components that make up the page, such as charts, tables, or controls.

### Usage notes
- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.
- Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.
- To retrieve pages from version-tagged workbooks, pass the `tag` 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 saved view (formerly called a bookmark), 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.

## Path parameters

- `workbookId` string, required
- `pageId` string, required

## Query parameters

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

## Response `200`

The response body.

- WorkbooksListWorkbookPageElementsResponse200
  - `entries` V2WorkbooksWorkbookIdPagesPageIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems[], required
    - `elementId` string, required
    - `name` string
    - `type` string
    - `columns` string[]
    - `vizualizationType` string
    - `error` string
  - `nextPage` string, nullable, required
  - `total` number, double

---

[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)