Skip to main content
GET
Browse Appointments

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

Operators

The not_has operator applies to related attributes, which this endpoint does not have.

Filter attributes

Each attribute above is also a valid sort key, for example ?sort=-scheduled_start_at for descending order.

Search attributes

filter[search] runs one partial match term across status, tags.handle. A record matches when any one of those attributes contains the term.

Custom field filters

Appointment records carry custom fields, so this endpoint also accepts filter[custom_field][namespace:handle].

Query Parameters

page[size]
string

Response

Array of Appointment

data
Appointment · object[]
required