---
title: "List workbooks"
method: GET
path: "/v2/workbooks"
tags: ["Workbooks"]
---

# List workbooks

`GET /v2/workbooks`

## Request

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

This endpoint retrieves a list of all available workbooks.

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

  Users with the Admin account type can optionally retrieve all workbooks 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
  - **Workbook navigation:** Allows users to easily navigate through their collection of workbooks and access the one they need.
  - **Integration points:** Useful for building integrations that need to present users with a list of their available workbooks, such as in custom applications using Sigma Embeds.

## Query parameters

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

## Response `200`

The response body.

- WorkbooksListWorkbooksResponse200
  - `entries` V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `workbookId` string, required: Unique identifier of the workbook.
    - `workbookUrlId` string, required
    - `name` string, required
    - `url` string, required
    - `path` string, required
    - `latestVersion` number, double, required: The most recently published document version of the workbook.
    - `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` V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems[]
      - `versionTagId` string, required: Unique identifier of the tag.
      - `name` string, required
      - `sourceWorkbookVersion` number, double, required
      - `taggedWorkbookId` string, required: Unique identifier of the tagged workbook.
      - `workbookTaggedAt` string, date-time, required
      - `isArchived` boolean: Whether the tagged workbook copy is archived.
    - `description` string
    - `taggedSourceUrlId` string: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request.
  - `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)