---
title: "List workbook controls"
method: GET
path: "/v2/workbooks/{workbookId}/controls"
tags: ["Workbooks"]
---

# List workbook controls

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

## Request

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

This endpoint retrieves all controls associated with a specific workbook. Controls are interactive elements like checkboxes, or dropdowns used within the workbook for dynamic data interaction.

### Usage notes
- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.

### Usage scenarios
- **Dynamic data interaction:** Allows users to interact dynamically with the data presented in the workbook through various control mechanisms.
- **Custom reporting:** Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements.

### Best practices
- Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation.
- Use detailed and descriptive names for controls to facilitate easier identification and use by end users.

## Path parameters

- `workbookId` string, required

## Query parameters

- `page` string
- `limit` number, double

## Response `200`

The response body.

- WorkbooksGetWorkbookControlsResponse200
  - `entries` V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItems[], required
    - `name` string, required
    - `valueType` union, required: Value of the control
      - 'boolean'
      - 'number'
      - 'text'
      - 'date'
      - 'number-list'
      - 'text-list'
      - 'date-list'
      - 'boolean-list'
      - 'date-range'
      - 'number-range'
      - 'date-null'
      - 'number-null'
      - 'text-null'
      - 'boolean-null'
  - `nextPage` string, nullable, required
  - `total` number, double

---

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