Acuity Scheduling tools
The 13 Acuity Scheduling operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List appointmentsGETLists the scheduled appointments of the account, newest first by default, up to max per call. There is no page token: when a call returns max appointments, narrow minDate and maxDate. Canceled appointments only come with canceled or showall.
- Get appointmentGETReturns one appointment, with the client's name, email and phone, datetime, endTime, type, calendar, price, paid, notes, the intake answers in forms, labels and confirmationPage. A canceled appointment also has noShow.
- Create appointmentPOSTBooks an appointment and returns it. By default it is booked as a client would book it: the time must be open and the required intake fields answered. With admin true those checks are skipped and calendarID is required. The client gets the confirmation email and SMS unless noEmail is true.
- Update appointmentPUTUpdates the client details, intake answers or notes of an appointment and returns it. Only the fields sent change, and firstName and lastName cannot be cleared. Date, time and calendar change with Reschedule appointment.
- Cancel appointmentPUTCancels an appointment and returns it. A canceled appointment cannot be restored. By default the cancellation rules for clients apply; with admin true they are skipped and noShow can be set. The client gets the cancellation email and SMS unless noEmail is true.
- Reschedule appointmentPUTMoves an appointment to another date and time, another calendar or both, and returns it. The new time must be open unless admin is true. Canceled appointments and class series cannot be rescheduled. The client gets the rescheduling email and SMS unless noEmail is true.
- List appointment typesGETLists the appointment types, the services and classes that clients book, with id, name, duration in minutes, price, type (service, class or series), private and calendarIDs, the calendars that offer each one.
- List calendarsGETLists the calendars the account can access, usually one per staff member, with id, name, email, location and timezone.
- List available datesGETLists the dates of a month that have open times for an appointment type, the same dates the client scheduling page shows. Each item has date.
- List available timesGETLists the open start times of an appointment type on a date, the same times the client scheduling page shows. Each item has time, which goes as datetime to Create appointment or Reschedule appointment.
- List clientsGETLists the clients of the account, with firstName, lastName, email, phone and notes.
- Create clientPOSTAdds a client to the client list and returns it. A client that already exists gets 400 with the message That client already exists.
- List formsGETLists the intake forms, with appointmentTypeIDs, the appointment types each form is on, and fields: each field has the id that Create appointment and Update appointment take, name, type, required and options.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
