This API is not needed to integrate Acuity Scheduling with your website, it is intended for developers to access information outside of a website or develop custom application. See the website integration guides under Client's Scheduling Page within your account for the code and guides on embedding into your website.
Some parameters can be passed in to the scheduling page through the query string to change which options and defaults are shown to clients.
If the scheduler is embedded in your website you can also pass these to your website, and they'll be transferred into the embedded scheduler. For example,
http://YourWebsite.com/[email protected] will pre-fill
[email protected] into the embedded scheduler.
To pass the client's first name, last name, phone number, and e-mail address into the scheduling page:
Here's the complete list of available fields:
firstNamethe client's first name
lastNamethe client's last name
phonethe client's phone number
calendarIDselect a specific calendar
appointmentTypeselect a specific appointment type or type category using
appointmentTypelink to multiple appointment types like this:
certificateset a coupon code or package
quantityset the quantity of appointments to book
datetimea date and time for an appointment slot, parsed by
locationthe set location category for the calendar/s
To find the ID for calendar go to Calendars in your account and choose Direct Scheduling Link to find the link directly to that calendar. For appointment type go to Appointment Types and choose Direct Scheduling Link.
Intake Form data may also be passed in a similar manner. Data is set by fieldID which can be found by inspecting the client scheduler forms by right clicking a field and selecting Inspect, or contacting support. Formatting of the query string parameter depends on the field type.
- Text fields:
- Drop Down list and Checkbox list fields:
- Yes/No and Checkbox fields:
Data of fields in intake forms marked Internal Use Only can also be set in this manner.
Let's say you want a scheduling link which:
A) Prefills some client data
B) Selects a particular appointment type
C) Chooses a specific appointment time, eg. August 30th, 2017, 2pm (your time)
Each scheduling link starts with the base part of your scheduler url. In our case that would be
https://example.acuityscheduling.com/schedule.php but you should use your own scheduler link. This is followed by parameters, starting with a question mark
?. Each following parameter is separated by an ampersand
?firstName=Jane&lastName=McTest&field:237764=Relaxation! The first argument starts with
? and each following parameter is separated by an
&. In this example, we set a custom intake form as well.
&appointmentType=184520 Don't forget that
&datetime=2019-01-10+2:00pm Be sure to test out the datetime you set to, to make sure it's a valid appointment time and to make sure our servers understand it.
Our full link would look like this:
Updated 4 months ago