Query records

Search and page through the records of a type: filter tree, sort, full-text q, optional view_key as base, group_by counts and a signed cursor. Returns values keyed by field key plus relations and documents.

Authorization

bearerApiKey

AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

record_type_id*string

Resource identifier: record_type_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

q?string

Lengthlength <= 200

filter?

Filter tree (version 1): and/or groups of {field, op, value} conditions, nesting depth at most 3.

sort?array<>

Itemsitems <= 3

limit?integer

Range1 <= value <= 200

cursor?string

Lengthlength <= 2048

group_by?string

Lengthlength <= 64

view_key?string

Lengthlength <= 64

include_archived?boolean

archived?string

Value in

"active"
"all"
"only"

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/records/types/123e4567-e89b-42d3-a456-426614174000/rows/query" \  -H "Content-Type: application/json" \  -d '{}'

{}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

402application/problem+json

403application/problem+json

404application/problem+json

405application/problem+json

409application/problem+json

410application/problem+json

413application/problem+json

415application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

502application/problem+json

503application/problem+json

504application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`