Skip to main content
GET
List records from a view

Authorizations

x-api-key
string
header
required

Path Parameters

viewId
string
required

Query Parameters

pageNum
number
default:1

Page number (default: 1)

Required range: x >= 1
pageSize
number
default:25

Number of records per page (default: 25, max: 100)

Required range: 1 <= x <= 100
fields
string

Comma-separated field names to include in response

Example:

"field1,field2,field3"

sort
string

Comma-separated field names for sorting. Prefix with - for DESC

Example:

"createdAt,-priority"

where
string

Filter conditions: (field,op,value)~and(field2,op,value2)

Example:

"(status,eq,active)~and(priority,gt,5)"

viewId
string

View ID for pre-filtered view

Response

200 - application/json
list
object[]
required

Array of record objects

pageInfo
object
required