---
title: "List columns for a workbook element"
method: GET
path: "/v2/workbooks/{workbookId}/elements/{elementId}/columns"
tags: ["Workbooks"]
---

# List columns for a workbook element

`GET /v2/workbooks/{workbookId}/elements/{elementId}/columns`

## Request

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

This endpoint retrieves a list of columns associated with a specific element within a workbook. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis.

  ### Usage notes
  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.
  - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.

  ### Usage scenarios
  - **Data exploration:** Helps users to explore the data structure of a workbook element, facilitating deeper analysis and understanding.
  - **Integration tasks:** Useful for developers integrating Sigma with other tools, needing to know the data structure to map data accurately.

  ### Best practices
  - Validate the elementId to make sure it corresponds to the correct workbook element before querying.
  - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure.

## Path parameters

- `workbookId` string, required
- `elementId` string, required

## Query parameters

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

## Response `200`

The response body.

- WorkbooksGetElementColumnsResponse200
  - `entries` V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems[], required
    - `columnId` string, required: Column ID
    - `label` string, required: Column name
    - `formula` string, required: Column formula
    - `type` V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType, required: The column's data type, represented as a recursive type object.
  - `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)