Skip to main content
POST
Search a table's cells

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 the in-table search.

sorts and where are the grid's CURRENT ones, not a second query: a match's row_offset only means "scroll here" if the server counted the same listing the client is rendering.

query
string
required

The substring to look for; matched case-insensitively.

Required string length: 1 - 256
column_ids
string<uuid>[] | null

Restrict the search to these columns; omit to search every text column.

Maximum array length: 500
sorts
TableRowSortSchema · object[]

The sort the grid is showing, so offsets line up with it.

Maximum array length: 3
where
TableRowsWhereSchema · object | null

The filters the grid is showing, for the same reason.

Response

Successful Response

A search's matches, in listing order.

limit
integer
required

The cap that was applied.

matches
TableRowSearchMatchSchema · object[]
required

Matching cells, ordered by row offset then column.

total_matched
integer
required

Matches found, before the cap.

truncated
boolean
required

Whether more matches exist than were returned.