List

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Query for listing records with filters, sorts and pagination.

limit?integer

Page size. Values above 100 are clamped to 100.

Range0 <= value <= 100

Default20

offset?integer

Number of records to skip.

Range0 <= value

Default0

countMode?string

Total-count strategy for the response.

Default"estimated"

Value in

"none"
"estimated"
"exact"

sorts?array<>

Sort rules, applied in order.

filters?

Filter configuration: a combinator plus a flat list of rules.

timezone?string

IANA timezone for resolving @today dynamic filter values.

fields?array<string>

Attribute names to hydrate from reference edges. Omitted → all reference attributes are hydrated. An empty array disables reference hydration entirely (reference keys are absent from the response). Unknown names are ignored.

Response Body

curl -X POST "https://example.com/records/string/list" \  -H "x-timezone: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Path Parameters

Header Parameters

Request Body

Response Body

List

Path Parameters

Header Parameters

Request Body

Response Body

200