---
title: "Add Workbench Column"
method: POST
path: "/workbench/tables/{table_id}/columns"
tags: ["Workbench"]
---

# Add Workbench Column

`POST /workbench/tables/{table_id}/columns`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/workbench/tables/{table_id}/columns`
- Auth: HTTP bearer

Add a column.

`name` is the machine name rows are keyed by and is constrained to
`^[a-z][a-z0-9_]*$`; `display_name` is free text. Getting those the wrong
way round produces a column nothing can address.

## Path parameters

- `table_id` string, required: Table id (UUID).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WorkbenchColumnCreateRequest
  - `name` string, required: Machine name: lowercase, starting with a letter. This is the key row data is addressed by, which is why it is constrained while `display_name` is not.
  - `display_name` string, required
  - `data_type` 'text' | 'number' | 'boolean' | 'json'
  - `column_type` 'data' | 'formula' | 'raw_json'
  - `field_path` string, nullable: Path into a raw_json source column.
  - `source` string
  - `source_column_id` integer, nullable
  - `formula` string, nullable: Required for a formula column.

## Response `201`

Successful Response

- ApiResponseDict
  - `data` object, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)