Skip to main content
POST
List records

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

object
string
required

A UUID or slug to identify the object.

Body

application/json
sorts
object[]
required
filters
object[]

An array of attribute-based filters. Maximum 10 filters.

Maximum array length: 10
joinOperator
enum<string>
default:and

How to combine multiple attribute filters. Defaults to "and".

Available options:
and,
or
limit
number
default:100

The maximum number of results to return.

Required range: x <= 1000
offset
number
default:0

The number of results to skip over before returning.

Response

Success

data
object[]
required
has_more
boolean
required

Whether there are more records available beyond the current page.

total
number
required

The total number of records matching the query.