/appointments

get

https://acuityscheduling.com/api/v1/appointments

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Canceled Appointments

📘
canceled=true
By default, canceled appointments are not returned. To retrieve canceled appointments, use the query ?canceled=true. To retrieve both canceled and scheduled appointments, you can use ?showall=true.
Canceled appointment responses include a noShow field which is true if the admin has marked the appointment as a no-show, and false if the appointment is simply canceled.

Query Params

max

int32

Defaults to 100

maximum number of results

minDate

date

only get appointments this date and after

maxDate

date

only get appointments this date and before

calendarID

int32

show only appointments on calendar with specified ID

appointmentTypeID

int32

show only appointments of this type

canceled

boolean

Defaults to false

get canceled appointments

firstName

string

filter appointments for client first name

lastName

string

filter appointments for client last name

string

filter appointments for client e-mail address

phone

string

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

field:id

string

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

excludeForms

boolean

Defaults to false

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

direction

string

Defaults to DESC

ASC or DESC

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

Canceled Appointments

canceled=true

200200

401401