List appointments

get

http://localhost:1234/api/sites/multiscreen/{site_name}/booking/appointments

Returns the site's appointments, narrowed by any combination of the query parameters (status, attendee email, appointment type, staff member, and start/end/created/updated date ranges) and ordered by the sort_* parameters. Results are paginated: limit defaults to and is capped at 100, offset defaults to 0, and total_responses reports how many appointments match the filters across all pages, not how many are in this one - use it to decide whether to fetch another page.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_name

string

required

Query Params

limit

int32

Maximum number of results to return.

offset

int32

Number of results to skip.

status

array of strings

enum

Filter appointments by status.

status

Allowed:

attendee_email

string

Filter appointments by attendee email.

appointment_uid

string

Filter appointments by booking unique identifier.

appointment_types

array of strings

Filter appointments by appointment type identifiers.

appointment_types

after_start

string

Filter appointments with start after this date string.

before_end

string

Filter bookings with end before this date string.

after_created_at

string

Filter bookings that have been created after this date string.

before_created_at

string

Filter bookings that have been created before this date string.

after_updated_at

string

Filter bookings that have been updated after this date string.

before_updated_at

string

Filter bookings that have been updated before this date string.

sort_start

string

Sort results by their start time in ascending or descending order. Available options: asc, desc

sort_end

string

Sort results by their end time in ascending or descending order. Available options: asc, desc

sort_created

string

Sort results by their creation time (when booking was made) in ascending or descending order. Available options: asc, desc

sort_updated_at

string

Sort results by their updated time (for example when booking status changes) in ascending or descending order. Available options: asc, desc

staff_member_ids

array of strings

Filter appointments by staff member identifiers.

staff_member_ids

Responses

401

Unauthorized request - missing or invalid credentials

429

Rate limit exceeded - please refer to api documentation for limits

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Non-OK response from the server