Skip to main content

Query rows

Use this API to fetch rows by ALL / view / column-value / search-query / ids, optionally returning only the count

Path Parameters
tableId string REQUIRED
Request Body
mode string

Possible values: [ALL, BY_VIEW, BY_COLUMN_VALUE, BY_SEARCH_QUERY, BY_IDS]

Which rows to fetch. Defaults to ALL.

viewId string

Required when mode=BY_VIEW.

columnId string

Required when mode=BY_COLUMN_VALUE.

value string

The value to match when mode=BY_COLUMN_VALUE.

searchQuery string

Required when mode=BY_SEARCH_QUERY (case-insensitive substring).

rowIds string[]

Required when mode=BY_IDS.

countOnly boolean

If true, returns the integer row count instead of the rows.

Responses
200

OK

Schema OPTIONAL
object