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.

Dynamic Scheduling Page

Some parameters can be passed in to the scheduling page through the query string to change which options and defaults are shown to clients. To pass the client's first name, last name, phone number, and e-mail address into the scheduling page:

https://example.acuityscheduling.com/schedule.php?first_name=First&last_name=Last&phone=Phone&[email protected]

A specific calendar can be selected with the calendarID parameter and an appointment type with the appointmentType parameter. To find the ID for calendar go to Calendars in your account and choose Direct Link to find the link directly to that calendar. For appointment type go to Appointment Types, edit the type, then choose Direct Link in the upper right to find the link directly to select that appointment type.

Dynamic Intake Forms

Intake Form data may also be passed in a similar manner. Data is set by fieldID which may be retrieved by inspecting the client scheduler forms, or contacting support. Formatting of the query string parameter depends on the field type.

• Text fields: field:1=Wonderful
• Drop Down list and Checkbox list fields: field:2[]=First&field:2[]=Second
• Yes/No and Checkbox fields: field:3=yes&field:4=no

https://example.acuityscheduling.com/schedule.php?field:1=Wonderful

https://legoparty.acuityscheduling.com/schedule.php?calendarID=129545&first_name=Bob&last_name=Burger&appointmentType=274500&field:351472=New%20York,%20NY