> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Acuity Scheduling

> How to set up the Acuity Scheduling connector, plus the actions that are available.

![Acuity Scheduling](https://stackone-logos.com/api/acuity-scheduling/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/acuityscheduling/changelog.md)

[35 actions](#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](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Connector Profile · API Key](https://docs.stackone.com/connectors/acuityscheduling/guides/connector-profile/api-key.md)
>
> Connects a single Acuity account with its numeric User ID and API key over HTTP Basic auth. No app registration required...

> [card] [Connector Profile · OAuth 2.0](https://docs.stackone.com/connectors/acuityscheduling/guides/connector-profile/oauth-2-0.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Link Account · API Key](https://docs.stackone.com/connectors/acuityscheduling/guides/link-account/api-key.md)

> [card] [Link Account · OAuth 2.0](https://docs.stackone.com/connectors/acuityscheduling/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

api-v1

No scopes found

35 actions

ActionDescriptionRequired scopes

List Appointment Addons`acuityscheduling_list_appointment_addons`

List the addons that can be attached to appointments.

`api-v1`

List Appointments`acuityscheduling_list_appointments`

List appointments scheduled in the Acuity account.

`api-v1`

Get Appointment`acuityscheduling_get_appointment`

Get a single appointment by ID.

`api-v1`

Create Appointment`acuityscheduling_create_appointment`

Book a new appointment for a client.

`api-v1`

Update Appointment`acuityscheduling_update_appointment`

Update client details, intake form fields, notes or labels on an appointment.

`api-v1`

Cancel Appointment`acuityscheduling_cancel_appointment`

Cancel an existing appointment.

`api-v1`

Reschedule Appointment`acuityscheduling_reschedule_appointment`

Move an appointment to a different date, time or calendar.

`api-v1`

List Appointment Payments`acuityscheduling_list_appointment_payments`

List payment transactions recorded for an appointment.

`api-v1`

List Appointment Types`acuityscheduling_list_appointment_types`

List the appointment types offered by the account.

`api-v1`

Get Availability Dates`acuityscheduling_get_availability_dates`

Get the dates in a month that have available time slots.

`api-v1`

Get Availability Times`acuityscheduling_get_availability_times`

Get available time slots on a date for an appointment type.

`api-v1`

Get Availability Classes`acuityscheduling_get_availability_classes`

Get scheduled class offerings and remaining slots.

`api-v1`

Check Availability Times`acuityscheduling_check_availability_times`

Validate that a specific date and time is bookable.

`api-v1`

List Blocks`acuityscheduling_list_blocks`

List blocked-off time on calendars.

`api-v1`

Get Block`acuityscheduling_get_block`

Get a single block of blocked-off time by ID.

`api-v1`

Create Block`acuityscheduling_create_block`

Block off time on a calendar so it cannot be booked.

`api-v1`

Delete Block`acuityscheduling_delete_block`

Delete a block of blocked-off time.

`api-v1`

List Calendars`acuityscheduling_list_calendars`

List the calendars in the Acuity account.

`api-v1`

List Certificates`acuityscheduling_list_certificates`

List package and coupon certificate codes.

`api-v1`

Check Certificate`acuityscheduling_check_certificate`

Check whether a certificate code is valid for an appointment type.

`api-v1`

Create Certificate`acuityscheduling_create_certificate`

Create a package or coupon certificate code.

`api-v1`

Delete Certificate`acuityscheduling_delete_certificate`

Delete a certificate code.

`api-v1`

List Clients`acuityscheduling_list_clients`

List clients in the Acuity client list.

`api-v1`

Create Client`acuityscheduling_create_client`

Add a new client to the client list.

`api-v1`

Update Client`acuityscheduling_update_client`

Update an existing client identified by name and phone.

`api-v1`

Delete Client`acuityscheduling_delete_client`

Delete a client identified by name and phone.

`api-v1`

List Forms`acuityscheduling_list_forms`

List intake forms and their fields.

`api-v1`

List Labels`acuityscheduling_list_labels`

List the appointment labels defined in the account.

`api-v1`

Get Me`acuityscheduling_get_me`

Get the authenticated Acuity account.

`api-v1`

List Orders`acuityscheduling_list_orders`

List orders from the online store.

`api-v1`

Get Order`acuityscheduling_get_order`

Get a single store order by ID.

`api-v1`

List Products`acuityscheduling_list_products`

List products and packages in the online store.

`api-v1`

List Webhooks`acuityscheduling_list_webhooks`

List active dynamic webhook subscriptions.

`api-v1`

Create Webhook`acuityscheduling_create_webhook`

Subscribe a target URL to an Acuity event.

`api-v1`

Delete Webhook`acuityscheduling_delete_webhook`

Delete a dynamic webhook subscription.

`api-v1`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.