---
title: "List report pages"
method: GET
path: "/v2/reports/{reportId}/pages"
tags: ["Reports"]
---

# List report pages

`GET /v2/reports/{reportId}/pages`

## Request

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

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

### Usage notes
- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.
- To retrieve pages from a version-tagged report, pass the `tag` query parameter with the tag name. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.tagName` field in the response.

### Usage scenarios
- **Navigation:** Helps users and applications navigate through different pages of a report efficiently.
- **Content discovery:** Allows users to quickly view and access the variety of pages contained within a report.

### Best practices
- 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 report's content.

## Path parameters

- `reportId` string, required

## Query parameters

- `pageToken` string
- `pageSize` integer
- `tag` string

## Response `200`

The response body.

- ReportsListReportPagesResponse200
  - `entries` V2ReportsReportIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `pageId` string, required: Unique identifier of the report page.
    - `name` string: Display name of the report page.
    - `hidden` boolean: Whether the page is hidden from end users.
  - `nextPageToken` string: A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results. **Must be treated as an opaque string.**

---

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