---
title: "Get deployed workbook in tenant org (Beta)"
method: GET
path: "/v2/tenants/{tenantOrganizationId}/workbooks"
tags: ["Tenants"]
---

# Get deployed workbook in tenant org (Beta)

`GET /v2/tenants/{tenantOrganizationId}/workbooks`

## Request

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

Retrieve the workbook ID for a workbook deployed to a tenant organization for a given parent workbook and deployment policy.

### Usage notes
- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
- The parent workbook must be part of the specified deployment policy.
- The workbook must be deployed to the specified tenant organization.
- Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.
- Retrieve the **deploymentPolicyId** by calling the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint. 
- Retrieve the **parentWorkbookId** by calling the [/v2/deploymentPolicies/{deploymentPolicyId}/files](https://help.sigmacomputing.com/reference/list-inodes-for-deployment) endpoint and using the `workbookId` included in the response.
- For version-tagged deployment policies, you may pass either the source workbook ID or the version-tagged workbook ID as the **parentWorkbookId**.

## Path parameters

- `tenantOrganizationId` string, required

## Query parameters

- `parentWorkbookId` string
- `deploymentPolicyId` string

## Response `200`

The response body.

- TenantsGetTenantWorkbookResponse200
  - `workbookId` string, required: Unique identifier of the workbook deployed to the tenant organization
  - `workbookUrl` string, required: URL to access the workbook in the tenant organization

---

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