Skip to main content
POST

Authorizations

Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Path Parameters

object
string
required

A UUID or slug to identify the object to list records for.

Example:

"people"

Body

application/json
filter
object

An object used to filter results to a subset of results. Cannot be used together with filter_view_id. See the full guide to filtering and sorting here.

Example:
filter_view_id
string<uuid>

UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with filter. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view.

sorts
object[]

An object used to sort results. See the full guide to filtering and sorting here.

Sort by attribute

Example:
limit
number

The maximum number of results to return. Defaults to 500. See the full guide to pagination here.

Example:

500

offset
number

The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.

Example:

0

Response

Success

Success

data
object[]
required