v1

latestOpenAPI 3.1.02026-07-245018.1 KB

/appointments

Get a list of appointments currently scheduled for the authenticated user.

get/appointments

Query parameters

maxinteger

maximum number of results

minDatestring date

only get appointments this date and after

maxDatestring date

only get appointments this date and before

calendarIDinteger

show only appointments on calendar with specified ID

appointmentTypeIDinteger

show only appointments of this type

canceledboolean

get canceled appointments

firstNamestring

filter appointments for client first name

lastNamestring

filter appointments for client last name

emailstring

filter appointments for client e-mail address

phonestring

filter appointments for client phone number. If using a country code, ensure that the '+' is URL encoded to %2b for accurate results

field:idstring

filter appointments matching a particular custom intake form field eg. ?field:1234=Hello

excludeFormsboolean

don't include intake forms in the response object (speeds up the response)

directionstring

ASC or DESC

Response

200

All 5 operations