Skip to main content
POST
Group columns

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

Request body for grouping columns.

column_ids
string<uuid>[]
required

The columns to group; at least two, each currently ungrouped. They are pulled together at the leftmost member's position, keeping their current relative order. The LAST member becomes the group's output.

Minimum array length: 2
name
string | null

The group's name; omit for the default label.

Required string length: 1 - 255
run_condition
ManualColumnDefinition · object

A per-row gate every member without one of its own inherits. It may not read a column inside the group.

ui_color
enum<string> | null

Palette token for the group's band; omit for a neutral band.

Available options:
gray,
red,
orange,
amber,
green,
blue,
purple,
pink

Response

Successful Response

A user-managed column group, membership resolved in position order.

collapsed
boolean
required

Whether the grid folds the group down to its output members. Purely presentational: folded members' cells are still fetched, so expanding costs nothing.

created_at
string<date-time>
required
id
string<uuid>
required
members
TableColumnGroupMemberSchema · object[]
required

The member columns in position order, with their output flags.

name
string | null
required

The group's name; null renders the client default label.

table_id
string<uuid>
required
ui_color
enum<string> | null
required

Palette token for the group's band, or null for a neutral band. A token rather than a hex: the grid renders light and dark, and one stored colour is only legible in one of them.

Available options:
gray,
red,
orange,
amber,
green,
blue,
purple,
pink
updated_at
string<date-time>
required
run_condition
ManualColumnDefinition · object

The group's per-row gate, verbatim; null gates nothing. Every member without a gate of its own carries a copy in its run_condition (marked by run_condition_group_id), so the columns themselves say what runs.