Skip to main content
POST
Export table rows as CSV

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 a table CSV export.

Two scopes, one body. Send sorts/where to export what the grid is currently showing — the same vocabulary the rows query accepts, so a filtered view exports exactly the rows the user can see. Send record_ids to export a specific selection instead. The two are mutually exclusive: an enumerated selection has already answered the question a filter asks.

column_ids is the projection, in display order, so hiding or reordering a column in the grid is reflected in the file.

column_ids
string<uuid>[] | null

Export these columns, in this order. Omit for every column, in the table's own column order.

Maximum array length: 500
record_ids
string<uuid>[] | null

Export exactly these rows, in display order. Mutually exclusive with sorts and where.

Maximum array length: 1000
sorts
TableRowSortSchema · object[]

Order rows by these columns instead of the display order.

Maximum array length: 3
where
TableRowsWhereSchema · object | null

Export only rows satisfying this predicate tree.

Response

The table as a CSV file.