v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

get/sites/multiscreen/{site_name}/booking/appointments

Path parameters

site_namestring required

The unique identifier of the target site.

Query parameters

limitinteger

Maximum number of results to return.

offsetinteger

Number of results to skip.

statusstring[]

Filter appointments by status. Available values: upcoming, recurring, past, cancelled, unconfirmed

attendee_emailstring

Filter appointments by attendee email.

appointment_uidstring

Filter appointments by booking unique identifier.

appointment_typesstring[]

Filter appointments by appointment type identifiers.

after_startstring

Filter appointments with start after this date string.

before_endstring

Filter bookings with end before this date string.

after_created_atstring

Filter bookings that have been created after this date string.

before_created_atstring

Filter bookings that have been created before this date string.

Response

200

limitinteger

Page size applied for request

offsetinteger

Offset applied for request

site_namestring

Owning site

total_responsesinteger

Total amount of elements matching requested filters