Skip to main content
POST
Query a listing's row IDs

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

Request body for the row-ID manifest.

The same listing vocabulary as the rows query, minus the projection: this asks which rows a listing selects and in what order, not what is in them. Answering it reads no cell payload, so a client can hold a whole table's ordering cheaply and then hydrate only the window it is showing.

cursor
string | null

Opaque cursor from a previous page's next_page_cursor. The rows query and the row-ID manifest answer the same cursor for the same place in a listing, and either reads the other's.

Maximum string length: 4096
limit
integer
default:10000

Maximum record IDs per page. Far higher than the rows query's limit because a page of IDs carries no cells.

Required range: 1 <= x <= 10000
offset
integer | null

Start the listing this many rows in. Mutually exclusive with cursor.

Required range: x >= 0
row_status
enum<string> | null

Restrict to rows whose cells are errored or fully_computed.

Available options:
errored,
fully_computed
sorts
TableRowSortSchema · object[]

Order by these columns, in priority order, instead of display order.

Maximum array length: 3
where
TableRowsWhereSchema · object | null

The predicate tree every returned row must satisfy.

Response

Successful Response

data
string<uuid>[]

The list of ResponseItems.

next_page_cursor
string | null

The cursor to the next page. If there are no more pages, this is None.

previous_page_cursor
string | null

The cursor to the previous page. If there are no previous pages, this is None.