v1
latestOpenAPI 3.0.12026-07-133870165.8 KBAppointments
Get Appointments
Use this endpoint to return a List of Appointments. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. For more information: Appointments Overview
get/consumer/v1/appointments
Query parameters
locationIdstring
id of business location
emailstring
Filter by email address
lastnamestring
Filter by lastname or part of it
phonestring
Filter by phone number or part of it
serviceIdstring
Filter by service
calendarIdstring
Filter by calendar
resourceIdstring
Filter by resource
customerIdstring
Filter by customer
serviceAllocationIdstring
Filter by service allocation
startDatestring date-time
Format YYYY-MM-DD. Filter by on/after startDate
endDatestring date-time
Format YYYY-MM-DD. Filter on/before endDate
statusstring
Filter by status: IN, BK, CN, RE, RS
bookedBystring
Filter by the email of who booked
offsetinteger
Starting row of page, default 0
limitinteger
Page limit, default 20, max 100
Response
Success