v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB

Appointments

List 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/setup/v1/appointments

Query parameters

locationIdstring

id of business location, defaults to primary business location

emailstring

Filter appointments by email address

lastnamestring

Filter appointments by lastname or part of

serviceIdstring

Filter appointments by service

calendarIdstring

Filter appointments by calendar

resourceIdstring

Filter appointments by resource

customerIdstring

Filter appointments by customer

serviceAllocationIdstring

Filter appointments by service allocation

startDatestring date-time

Format YYYY-MM-DD: Filter appointments by on/after startDate

endDatestring date-time

Format YYYY-MM-DD: Filter appointments on/before endDate

statusstring

Filter appointments by status: IN, BK, CN, RE, RS

bookedBystring

Filter appointments by user email who booked

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

Success

objectstring nullable

urlstring nullable

hasMoreboolean

countinteger

totalinteger

All 139 operations