---
title: "Get workbook schema"
method: GET
path: "/v2/workbooks/{workbookId}/schema"
tags: ["Workbooks"]
deprecated: true
---

# Get workbook schema

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

## Request

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

> **Deprecated.**

The Workbook Schema API is deprecated as of December 15, 2023. This endpoint is no longer compatible with workbook layouts. Workflows that use this endpoint must be replaced with the new endpoints listed below. The components in Workbook Schema API are available through individual endpoints to minimize the retrieval of unnecessary data.

- [GET v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/listworkbookpages)
- [GET v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/listworkbookpageelements)
- [GET v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/listworkbookqueries)
- [GET v2/workbooks/{workbookId}/elements/{elementId}/query](https://help.sigmacomputing.com/reference/getelementquery)

## Path parameters

- `workbookId` string, required

## Query parameters

- `includeSql` boolean
- `tag` string

## Response `200`

The response body.

- WorkbooksGetWorkbookSchemaResponse200
  - `workbookId` string, required: Unique identifier of the workbook.
  - `workbookUrlId` string, required
  - `pages` object, required
  - `sheets` object, required
  - `variables` object, required
  - `elements` object, required
  - `sqlQueries` object, required
  - `sqlQueryErrors` object, required

---

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