Skip to main content
POST
Export rows as CSV or JSON (follows every page)

Body

application/json
base
string
required

Base id or slug

console
string

Console base URL

filter
string

Query AST filter, inline JSON or @file

format
string

csv|json (default csv)

includeBody
boolean

Include the row body when readable

maxRows
string

Stop after this many rows (default and max 100000)

out
string

Write to this file instead of stdout

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)

view
string

Read or write through this view (its columns, filter, and access apply)

Response

Success — body conforms to the @Returns schema.

baseRef
string
required
columns
string[]
required
consoleUrl
string
required
content
string | null
required
format
string
required
outFile
string | null
required
projectRef
string
required
rowCount
number
required
success
boolean
required
truncated
boolean
required
viewId
string | null
required