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

# List workbook pages for a workbook

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

## Request

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

This endpoint retrieves a list of all pages contained within a specified workbook. It is useful for applications needing to display an overview or navigate through different pages of a workbook.

### Usage notes
- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) 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 pages 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
- **Navigation:** Helps users and applications navigate through different pages of a workbook efficiently.
- **Content Discovery:** Allows users to quickly view and access the variety of pages contained within a workbook.

### Best practices
- Always name pages to make it easy for users to navigate.
- Utilize pagination to manage and streamline the retrieval of large numbers of pages.
- Ensure that users or systems querying this endpoint have appropriate permissions to access the workbook's content.

## Path parameters

- `workbookId` string, required

## Query parameters

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

## Response `200`

The response body.

- WorkbooksListWorkbookPagesResponse200
  - `entries` V2WorkbooksWorkbookIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems[], required
    - `pageId` string, required: Unique identifier of the workbook page.
    - `name` string
    - `hidden` boolean
  - `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)