Log inStart free trial

Acuity Scheduling API: Watch Addons, Cancel an Appointment

Online appointment scheduling for service businesses and calendars. 8 triggers, 17 searches, and 14 actions including Watch Addons.

About this integration

Online appointment scheduling for service businesses and calendars. Connect it to any workflow without writing code.

You can choose from 8 triggers, 17 search modules and 14 actions. The connection type is basic authentication.

How to connect

The credential form asks for User ID and API Key.

Prefer the interactive builder form? Open it on the app page.

Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.

Field	Type	Help
User IDRequired	text	Go to `https://secure.acuityscheduling.com/app.php?action=settings&key=api` to obtain your user id
API KeyRequired	password	Go to `https://secure.acuityscheduling.com/app.php?action=settings&key=api` to obtain your API Key

Use it in workflow automation

Start with Watch Addons, then add Cancel an Appointment.

The canvas below runs Watch Addons into Cancel an Appointment — watch the video, then drop a node onto the canvas.

Select the Watch Appointments trigger and the workflow fires automatically when the event occurs — no polling required.

Then add Cancel an Appointment as the next node. Branch, filter, or hand off to other integrations from there.

The integration includes 22 ready-made modules for scheduling work — each run logs its inputs and outputs for debugging.

Acuity Scheduling workflow on the canvas: Watch Appointments then Cancel an Appointment

Acuity Scheduling workflow on the canvas: Watch Appointments then Cancel an Appointment

Triggers, searches and actions

Explore the fields available for each Acuity Scheduling trigger, search, and action — 8 triggers, 17 searchs, and 14 actions.

Triggers

Whenever something changes in the app, one of 8 available triggers can start a run immediately.

Watch Addons
Watch Appointments
Watch Blocks
Watch Calendar
Watch Cartificates

3more triggers

Searches

17 search modules let you query the app mid-run and feed the results to the next step.

Get a Block
Get a Client
Get an Appointment
Get an Order
List Addons

12more searches

Actions

Use 14 action modules to write data back into the app from anywhere in a run.

Cancel an Appointment
Check a Cerificate
Check Appointment Availability
Create a Block
Create a Cerificate

9more actions

Explore the fields available for each Acuity Scheduling trigger, search, and action.

Triggers

Output fields

Field	Type
ID	number
Name	text
Duration	number
Price	text
Private	boolean

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields

Output fields

Field	Type
Description	text
Until	text
Recurring	text
Notes	text
End	date
Start	date
Calendar ID	number
ID	number

Output fields

Field	Type
ID	number
Name	email
Email	email
Reply to	text
Description	text
Location	text
Timezone	time

Output fields

Field	Type
ID	number
Certificate	text
Product ID	number
Order ID	text
Appointment type i ds	array
Name	text
Email	email
Type	text
Remaining counts	object
1	number
Remaining minutes	text
Expiration	text

Output fields

Field	Type
ID	number
Appointment type i ds	array
Description	text
Hidden	boolean
Name	text
Fields	array

Output fields

Field	Type
ID	number
Total	text
Status	text
Time	date
First name	text
Last name	text
Phone	text
Email	email
Title	text
Notes	text

Output fields

Field	Type
ID	number
Name	text
Description	text
Price	text
Type	text
Hidden	boolean
Expires	boolean
Appointment type i ds	array
Appointment type counts	text
Minutes	number

Searches

Input fields

Field	Type
Block IDRequired	choice

Output fields

Field	Type
Description	text
Until	text
Recurring	text
Notes	text
End	date
Start	date
Calendar ID	number
ID	number

Input fields

Field	Type
SearchRequired	text

Output fields

Field	Type
First name	text
Last name	text
Phone	text
Notes	text

Input fields

Field	Type
Appointment IDRequired	choice

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields

Input fields

Field	Type
Order IDRequired	choice

Output fields

Field	Type
ID	number
Total	text
Status	text
Time	date
First name	text
Last name	text
Phone	text
Email	email
Title	text
Notes	text

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	number
Name	text
Duration	number
Price	text
Private	boolean

Input fields

Field	Type
Month	date
Appointment Type ID	choice
Calendar ID	choice
Timezone	time
Minimum Date	date
Maximum Date	date
Include Unavailable	boolean
Include Private	boolean
Limit	number

Output fields

Field	Type
ID	number
Appointment type ID	number
Calendar ID	number
Name	text
Time	date
Calendar	text
Duration	number
Is series	boolean
Slots	number
Slots available	number

Input fields

Field	Type
Month	date
Appointment Type ID	choice
Calendar ID	choice
Addon IDs	choice
Timezone	time
Limit	number

Output fields

Field	Type
Date	date

Input fields

Field	Type
Appointment IDRequired	choice
Limit	number

Output fields

Field	Type
Transaction ID	text
Created	date
Processor	text
Amount	text

Input fields

Field	Type
Calendar ID	choice
Appointment Type ID	choice
Min Date	date
Max Date	date
Canceled	boolean
First Name	text
Last Name	text
Email	email
Phone	text
Field ID	text
Exclude Forms	boolean
Direction	choice
Limit	number

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields

Input fields

Field	Type
Date	date
Appointment Type ID	choice
Calendar ID	choice
Addon IDs	choice
Timezone	time
Ignore Appointment IDs	choice
Limit	number

Output fields

Field	Type
Time	date

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	number
Active	text
Name	text
Description	text
Duration	number
Price	text
Category	text
Color	text
Private	boolean
Type	text
Class size	text
Padding after	number
Padding before	number
Calendar i ds	array

Input fields

Field	Type
Calendar ID	choice
Minimum Date	date
Maximum Date	date
Limit	number

Output fields

Field	Type
Description	text
Until	text
Recurring	text
Notes	text
End	date
Start	date
Calendar ID	number
ID	number

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	number
Name	email
Email	email
Reply to	text
Description	text
Location	text
Timezone	time

Input fields

Field	Type
Product ID	choice
Order ID	choice
Appointment Type ID	choice
Email	email
Limit	number

Output fields

Field	Type
ID	number
Certificate	text
Product ID	number
Order ID	text
Appointment type i ds	array
Name	text
Email	email
Type	text
Remaining counts	object
1	number
Remaining minutes	text
Expiration	text

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	number
Appointment type i ds	array
Description	text
Hidden	boolean
Name	text
Fields	array

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	number
Total	text
Status	text
Time	date
First name	text
Last name	text
Phone	text
Email	email
Title	text
Notes	text

Input fields

Field	Type
Limit	number

Output fields

Field	Type
ID	number
Name	text
Description	text
Price	text
Type	text
Hidden	boolean
Expires	boolean
Appointment type i ds	array
Appointment type counts	text
Minutes	number

Actions

Input fields

Field	Type
Appointment IDRequired	choice
Admin	boolean

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields

Input fields

Field	Type
CertificateRequired	choice
Appointment Type IDRequired	choice
Email	email

Output fields

Field	Type
ID	number
Certificate	text
Product ID	number
Order ID	text
Appointment type i ds	array
Name	text
Email	text
Type	text
Remaining counts	object
1	number
Remaining minutes	text
Expiration	text

Input fields

Field	Type
Appointment AvalabiltyRequired	array

Output fields

Field	Type
Datetime	date
Appointment type ID	number
Calendar ID	number
Valid	boolean

Input fields

Field	Type
StartRequired	date
EndRequired	date
Calendar IDRequired	choice
Notes	text

Output fields

Field	Type
Description	text
Until	text
Recurring	text
Notes	text
End	date
Start	date
Calendar ID	number
ID	number

Input fields

Field	Type
Product ID	choice
Order ID	choice
Appointment Type ID	choice
Email	email
Limit	number

Output fields

Field	Type
ID	number
Certificate	text
Product ID	number
Order ID	text
Appointment type i ds	array
Name	text
Email	email
Type	text
Remaining counts	object
1	number
Remaining minutes	text
Expiration	text

Input fields

Field	Type
First NameRequired	text
Last NameRequired	text
Phone	text
Email	email
Notes	text

Output fields

Field	Type
First name	text
Last name	text
Phone	text
Notes	text

Input fields

Field	Type
DatetimeRequired	text
Appointment Type IDRequired	choice
First NameRequired	text
Last NameRequired	text
EmailRequired	email
Calendar ID	choice
Phone	text
Timezone	time
Certificate	text
Fields	array
Notes	text
Addon IDs	choice
Labels	array
SMS Opt In	boolean

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields

Input fields

Field	Type
Block IDRequired	choice

Input fields

Field	Type
Certificate IDRequired	choice

Input fields

Field	Type
First NameRequired	text
Last NameRequired	text
Phone	text

Input fields

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields

Field	Type
Body	text
Headers	object
Status code	number

Input fields

Field	Type
Appointment IDRequired	choice
DatetimeRequired	text
Calendar ID	choice
Timezone	time

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields

Input fields

Field	Type
First NameRequired	text
Last NameRequired	text
Phone	text
Email	email
Notes	text

Output fields

Field	Type
First name	text
Last name	text
Phone	text
Notes	text

Input fields

Field	Type
Appointment IDRequired	choice
Datetime	text
Appointment Type ID	choice
First Name	text
Last Name	text
Email	email
Calendar ID	choice
Phone	text
Timezone	time
Certificate	text
Fields	array
Notes	text
Addon IDs	choice
Labels	array
SMS Opt In	boolean

Output fields

Field	Type
ID	number
First name	text
Last name	text
Phone	text
Email	email
Date	date
Time	time
End time	text
Date created	date
Datetime	date
Price	text
Paid	text
Amount paid	text
Type	text
Appointment type ID	number
Addon i ds	array
Class ID	text
Duration	text
Calendar	text
Calendar ID	number

10other output fields