Acuity Scheduling - Apps Documentation

Requirements

Connecting Acuity Scheduling takes an active account plus an API access token from your account settings — no other setup is required.[3]

Get your Acuity Scheduling credentials

User IDtextRequired
Go to https://secure.acuityscheduling.com/app.php?action=settings&key=api to obtain your user id
[1]
API KeypasswordRequired
Go to https://secure.acuityscheduling.com/app.php?action=settings&key=api to obtain your API Key
[1]

Connect Acuity Scheduling in WEXTL

Log in to your WEXTL account, add the Acuity Scheduling node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Acuity Scheduling account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Acuity Scheduling node modules

The list below is a reference of every Acuity Scheduling node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any Acuity Scheduling node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch AddonsTrigger

Output fields[3]

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

Watch AppointmentsTrigger

Output fields[3]

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

Watch BlocksTrigger

Output fields[3]

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

Watch CalendarTrigger

Output fields[3]

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

Watch CartificatesTrigger

Output fields[3]

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

Watch FormsTrigger

Output fields[3]

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

Watch OrdersTrigger

Output fields[3]

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

Watch ProductsTrigger

Output fields[3]

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

Get a BlockAction

Input fields[3]

Field	Type
Block IDRequired	choice

Output fields[3]

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

Get a ClientAction

Input fields[3]

Field	Type
SearchRequired	text

Output fields[3]

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

Get an AppointmentAction

Input fields[3]

Field	Type
Appointment IDRequired	choice

Output fields[3]

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

Get an OrderAction

Input fields[3]

Field	Type
Order IDRequired	choice

Output fields[3]

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

List AddonsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

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

List Appointment ClassesSearch

Input fields[3]

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[3]

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

List Appointment DatesSearch

Input fields[3]

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

Output fields[3]

Field	Type
Date	date

List Appointment PaymentsSearch

Input fields[3]

Field	Type
Appointment IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Transaction ID	text
Created	date
Processor	text
Amount	text

List Appointment TimesSearch

Input fields[3]

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

Output fields[3]

Field	Type
Time	date

List Appointment TypesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

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

List AppointmentsSearch

Input fields[3]

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[3]

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

List BlocksSearch

Input fields[3]

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

Output fields[3]

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

List CalendarsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

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

List CertificatesSearch

Input fields[3]

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

Output fields[3]

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

List FormsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

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

List OrdersSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

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

List ProductsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

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

Cancel an AppointmentAction

Input fields[3]

Field	Type
Appointment IDRequired	choice
Admin	boolean

Output fields[3]

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

Check a CerificateAction

Input fields[3]

Field	Type
CertificateRequired	choice
Appointment Type IDRequired	choice
Email	email

Output fields[3]

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

Check Appointment AvailabilityAction

Input fields[3]

Field	Type
Appointment AvalabiltyRequired	array

Output fields[3]

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

Create a BlockAction

Input fields[3]

Field	Type
StartRequired	date
EndRequired	date
Calendar IDRequired	choice
Notes	text

Output fields[3]

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

Create a CerificateAction

Input fields[3]

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

Output fields[3]

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

Create a ClientAction

Input fields[3]

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

Output fields[3]

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

Create an AppointmentAction

Input fields[3]

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[3]

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

Delete a BlockAction

Input fields[3]

Field	Type
Block IDRequired	choice

Delete a CerificateAction

Input fields[3]

Field	Type
Certificate IDRequired	choice

Delete a ClientAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
Phone	text

Make an API Calluniversal

Input fields[3]

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

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Reschedule an AppointmentAction

Input fields[3]

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

Output fields[3]

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

Update a ClientAction

Input fields[3]

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

Output fields[3]

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

Update an AppointmentAction

Input fields[3]

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[3]

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

Templates

Look for Acuity Scheduling templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Scheduling category →

References

WEXTL® Acuity Scheduling Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Acuity Scheduling.
WEXTL® visual workflow builder data.

Last updated: Aug 4, 2026 19:48

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.