acuity-scheduling

# Acuity Scheduling

Acuity Scheduling is a tool that allows businesses to offer online appointment scheduling to their clients. It's used by service-based businesses like salons, therapists, and consultants to manage their availability and bookings.

Official docs: https://developers.squarespace.com/acuity-scheduling-api

## Acuity Scheduling Overview

- **Appointment**
  - **Appointment Type**
- **Calendar**
- **Class**
- **Package**
- **Gift Certificate**
- **Subscription**
- **User**
- **Report**

Use action names and parameters as needed.

## Working with Acuity Scheduling

This skill uses the Membrane CLI to interact with Acuity Scheduling. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to Acuity Scheduling

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://www.acuityscheduling.com/" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
|---|---|---|
| List Appointments | list-appointments | Get a list of appointments for the authenticated user with optional filtering |
| List Clients | list-clients | Get a list of clients with optional filtering by name, email, or phone |
| List Appointment Types | list-appointment-types | Get a list of all appointment types configured for the account |
| List Calendars | list-calendars | Get a list of all calendars for the authenticated user |
| List Blocks | list-blocks | Get a list of blocked off times for a calendar |
| Create Appointment | create-appointment | Create a new appointment |
| Create Client | create-client | Create a new client |
| Create Block | create-block | Create a new blocked off time |
| Update Appointment | update-appointment | Update an existing appointment |
| Update Client | update-client | Update an existing client |
| Get Appointment | get-appointment | Retrieve a single appointment by its ID |
| Get Block | get-block | Retrieve a single block by its ID |
| Cancel Appointment | cancel-appointment | Cancel an existing appointment |
| Delete Client | delete-client | Delete a client by ID |
| Delete Block | delete-block | Delete a blocked off time |
| Get Available Times | get-available-times | Get available time slots for a specific date |
| Get Available Dates | get-available-dates | Get available dates for booking an appointment |
| Reschedule Appointment | reschedule-appointment | Reschedule an existing appointment to a new date/time |
| List Forms | list-forms | Get a list of intake forms configured for the account |
| Get Current User | get-me | Get information about the currently authenticated user |

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
```

The result is in t