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

# Acuity Scheduling

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental reading is only supported for `appointments`, `availability/classes`, `blocks`. For all other objects, a full read of the Acuity Scheduling instance will be done per scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://acuityscheduling.com`.

### Supported objects

The Acuity Scheduling connector supports reading from the following objects:

* [appointments](https://developers.acuityscheduling.com/reference/get-appointments)
* [appointment-addons](https://developers.acuityscheduling.com/reference/appointments-addons)
* [appointment-types](https://developers.acuityscheduling.com/reference/appointment-types)
* [availability/classes](https://developers.acuityscheduling.com/reference/get-availability-classes)
* [blocks](https://developers.acuityscheduling.com/reference/blocks)
* [calendars](https://developers.acuityscheduling.com/reference/get-calendars)
* [certificates](https://developers.acuityscheduling.com/reference/get-certificates)
* [clients](https://developers.acuityscheduling.com/reference/clients)
* [forms](https://developers.acuityscheduling.com/reference/forms)
* [labels](https://developers.acuityscheduling.com/reference/labels)
* [orders](https://developers.acuityscheduling.com/reference/get-orders)
* [products](https://developers.acuityscheduling.com/reference/get-products)

The Acuity Scheduling connector supports writing to the following objects:

* [appointments](https://developers.acuityscheduling.com/reference/post-appointments)
* [blocks](https://developers.acuityscheduling.com/reference/post-blocks)
* [certificates](https://developers.acuityscheduling.com/reference/post-certificates)
* [clients](https://developers.acuityscheduling.com/reference/post-clients)

### Example integration

For an example manifest file of an Acuity Scheduling integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/acuityscheduling/amp.yaml).

## Before You Get Started

To integrate Acuity Scheduling with Ampersand, you will need [an Acuity Scheduling Account](https://acuityscheduling.com/).

Once your account is created, you'll need to register an Oauth app and obtain the following credentials from your app:

* Client ID
* Client Secret
* Scopes

You will then use these credentials and scopes to connect your application to Ampersand.

### Create an Acuity Scheduling Account

Here's how you can sign up for an Acuity Scheduling account:

* Go to the [Acuity Scheduling Sign Up page](https://login.squarespace.com/api/1/login/oauth/provider/authorize?client_id=aHW16IlRwTPNctfSvoofuCarXfdJDvJK\&state=U2dzVitmZFBhVjd0aGJpekJHcFdkU0JoTHY4bnk5U3dGTHRNN3c2MlVidz06eyJ1IjowLCJ4IjoxNzIyNTA5MjA2LCJuIjoiZTZlYmVkZTcifQ%3D%3D\&redirect_uri=https%3A%2F%2Fsecure.acuityscheduling.com%2Foauth2%2Fsquarespace-trial%2Fcallback\&access_type=offline\&action=form\&type=professional\&freeTrial=1\&lite=1\&btn=nav\&action=form\&type=professional\&freeTrial=1\&lite=1\&btn=nav\&overrideLocale=en-US\&device_id=d000e6d3-e4b3-4e9a-b8f5-5136c400de1e\&analytics_id=d000e6d3-e4b3-4e9a-b8f5-5136c400de1e\&entry_point=acuity#/signup).
* Sign up using your preferred method and complete any necessary verification.

### Creating an Acuity Scheduling App

Follow the steps below to create an Acuity Scheduling app:

1. Go to [Acuity Scheduling OAuth2 Account Registration](https://acuityscheduling.com/developers).
2. Enter the following details:
   1. \*\*Account Name: \*\*The name of your Acuity Scheduling account or organization.
   2. \*\*Email Address: \*\*The email address associated with your Acuity Scheduling account. This will be used for communication regarding your app.
   3. \*\*Website: \*\*The URL of your application's website. This helps users understand what your application does.
   4. **Application Description:** A brief description of your application and its purpose.
   5. **Callback URIs:** Enter the Redirect URI as `https://api.withampersand.com/callbacks/v1/oauth`. This URI is where users will be redirected after authorizing your app.
3. Click **Save**.

<img src="https://mintcdn.com/ampersand-24eb5c1a/p4alBfPjHeNuBPh1/images/provider-guides/284e851-acuity1.gif?s=00d414e75817d956887c72a58b0d6ebb" alt="Acuity Scheduling App Creation" width="1680" height="824" data-path="images/provider-guides/284e851-acuity1.gif" />

You will see the **Client ID** and **Client Secret** in the app details. Note these credentials, as you will need them to connect your app to Ampersand.

<img src="https://mintcdn.com/ampersand-24eb5c1a/i4a56x-Fmj6u7jdE/images/provider-guides/bfdd528-acuity2.jpeg?fit=max&auto=format&n=i4a56x-Fmj6u7jdE&q=85&s=74dc2620bd186bfd10c82e4318c2cfad" alt="Acuity Scheduling App Creation" width="1200" height="1028" data-path="images/provider-guides/bfdd528-acuity2.jpeg" />

## Add Your Acuity Scheduling App Info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to create an Acuity Scheduling integration.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/dd47b7a-Ampersand.png?fit=max&auto=format&n=CkzFg-K1u4gYx3ZD&q=85&s=d580aa00cc421fe14cfbab79c2e0812f" alt="Ampersand Project Selection" width="2244" height="442" data-path="images/provider-guides/dd47b7a-Ampersand.png" />

3. Select **Provider Apps**.

4. Select *Acuity Scheduling* from the **Provider** list.

5. Enter the previously obtained **Client ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field.

6. Enter the scopes set for your application in *Acuity Scheduling*.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/f4bc1a4-acuity3.gif?s=c2e199bec467cc5b99110dcdb77aedae" alt="Ampersand Integration" width="776" height="480" data-path="images/provider-guides/f4bc1a4-acuity3.gif" />

7. Click **Save Changes**.

## Using the connector

To start integrating with Acuity Scheduling:

* Create a manifest file like the [example above](#example-integration).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for OAuth authorization.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
