List workbook controls

View as MarkdownOpen in Claude
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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional
limitdoubleOptional

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldouble