Skip to main content
POST
Query rows through a view (its filter and columns apply)

Body

application/json
base
string
required

Base id or slug

view
string
required

View id

all
boolean

Follow cursors until the end or --max-rows

console
string

Console base URL

cursor
string

Opaque cursor from a previous page

filter
string

Query AST filter, inline JSON or @file

format
string

Human output: table|csv|json (default table)

includeBody
boolean

Include the row body when readable

limit
string

Rows per page, 1-500 (default 100)

maxRows
string

Stop following cursors after this many rows (default 10000, max 100000)

project
string

Console project id or slug; overrides the saved Console scope

sort
string

Comma-separated sort keys, key[:asc|desc], e.g. amount:desc,created_time (max 3)

Response

Success — body conforms to the @Returns schema.

baseRef
string
required
columns
string[]
required
consoleUrl
string
required
nextCursor
string | null
required
pagination
object
required
projectRef
string
required
rows
object[]
required
success
boolean
required
truncated
boolean
required
users
object
required
viewId
string | null
required