Skip to main content
POST
Create a table view

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

Request body for creating a saved view.

name
string
required

View name, unique per table.

Required string length: 1 - 255
description
string | null
Required string length: 1 - 2000
hidden_column_ids
string<uuid>[]

Columns the view hides.

Maximum array length: 500
is_default
boolean
default:false

Make this the table's default view: the one a link naming no view opens on, for a person with no last view of the table. Stands down whichever view held it; at most one view per table carries it.

position
integer
default:0

Display position in the view switcher; ties break by name.

Required range: x >= 0
sorts
TableRowSortSchema · object[]

Order rows by these columns, in priority order.

Maximum array length: 3
where
TableRowsWhereSchema · object | null

Predicate tree rows must satisfy while the view is applied.

Response

Successful Response

A saved view: named sort/filter/hidden-column overrides for one table.

created_at
string<date-time>
required
description
string | null
required
hidden_column_ids
string<uuid>[]
required

Columns the view hides.

id
string<uuid>
required
is_default
boolean
required

Whether opening the table with no view named applies this one, for a person with no last view of the table. At most one view per table carries it.

name
string
required
position
integer
required

Display position in the view switcher; ties break by name.

sorts
TableRowSortSchema · object[]
required

The view's sort keys, in priority order.

updated_at
string<date-time>
required
where
TableRowsWhereSchema · object | null
required

Predicate tree rows must satisfy while the view is applied.