Skip to main content
POST
Group columns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

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
updated_at
string<date-time>
required