Skip to main content
Acuity Scheduling
Betav0.1.0
35 actions · 2 auth methods

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Connects a single Acuity account with its numeric User ID and API key over HTTP Basic auth. No app registration required…

Connector Profile · OAuth 2.0

Requires registering an Acuity OAuth2 client. Access tokens do not expire and no refresh token is issued.
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
|
35 actions
Action
Description
Required scopes
List Appointment Addons
List the addons that can be attached to appointments.
List Appointments
List appointments scheduled in the Acuity account.
Get Appointment
Get a single appointment by ID.
Create Appointment
Book a new appointment for a client.
Update Appointment
Update client details, intake form fields, notes or labels on an appointment.
Cancel Appointment
Cancel an existing appointment.
Reschedule Appointment
Move an appointment to a different date, time or calendar.
List Appointment Payments
List payment transactions recorded for an appointment.
List Appointment Types
List the appointment types offered by the account.
Get Availability Dates
Get the dates in a month that have available time slots.
Get Availability Times
Get available time slots on a date for an appointment type.
Get Availability Classes
Get scheduled class offerings and remaining slots.
Check Availability Times
Validate that a specific date and time is bookable.
List Blocks
List blocked-off time on calendars.
Get Block
Get a single block of blocked-off time by ID.
Create Block
Block off time on a calendar so it cannot be booked.
Delete Block
Delete a block of blocked-off time.
List Calendars
List the calendars in the Acuity account.
List Certificates
List package and coupon certificate codes.
Check Certificate
Check whether a certificate code is valid for an appointment type.
Create Certificate
Create a package or coupon certificate code.
Delete Certificate
Delete a certificate code.
List Clients
List clients in the Acuity client list.
Create Client
Add a new client to the client list.
Update Client
Update an existing client identified by name and phone.
Delete Client
Delete a client identified by name and phone.
List Forms
List intake forms and their fields.
List Labels
List the appointment labels defined in the account.
Get Me
Get the authenticated Acuity account.
List Orders
List orders from the online store.
Get Order
Get a single store order by ID.
List Products
List products and packages in the online store.
List Webhooks
List active dynamic webhook subscriptions.
Create Webhook
Subscribe a target URL to an Acuity event.
Delete Webhook
Delete a dynamic webhook subscription.