List workbook controls

View as Markdown
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
Unique identifier of the workbook.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldoubleOptional