---
title: "List reports"
method: GET
path: "/v2/reports"
tags: ["Reports"]
---

# List reports

`GET /v2/reports`

## Request

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

This endpoint retrieves a list of all available reports.

Available reports include any reports in your My Documents folder and any reports you have access to.

Users with the Admin account type can optionally retrieve all reports in the organization.

### Usage notes
This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.

### Pagination

This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:

- hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.
- total: The total number of entries available across all pages.
- nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.

#### Example response for pagination
```json
{
  "hasMore": true,
  "total": 104,
  "nextPage": "50"
}
```

To request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return.

### Usage scenarios
- **Report navigation**: Allows users to view their collection of reports and locate ones they need.
- **Integration points**: Useful for building integrations that need to present users with a list of their available reports, such as in custom applications using embeds.

## Query parameters

- `page` string
- `limit` number, double
- `excludeTags` boolean
- `skipPermissionCheck` boolean
- `isArchived` boolean

## Response `200`

The response body.

- ReportsListReportsResponse200
  - `entries` V2ReportsGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `reportId` string, required: Unique identifier of the report.
    - `reportUrlId` string, required
    - `name` string, required
    - `url` string, required
    - `path` string, required
    - `latestVersion` number, double, required: The most recently published document version of the report.
    - `ownerId` string, required
    - `createdBy` string, required: The identifier of the user who created this object.
    - `updatedBy` string, required: The identifier of the user or process that last updated this object.
    - `createdAt` string, date-time, required: When the object was created.
    - `updatedAt` string, date-time, required: When the object was last updated.
    - `isArchived` boolean
    - `tags` V2ReportsGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems[]
      - `versionTagId` string, required: Unique identifier of the tag.
      - `tagName` string, required
      - `sourceVersion` number, double, required
      - `taggedAt` string, date-time, required
      - `taggedReportId` string, required: Unique identifier of the tagged report.
    - `description` string
  - `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)