> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/integrations/integration-reference/acuity-scheduling.md).

# Acuity Scheduling

Reward qualifying appointment and order activity from Acuity Scheduling.

## Integration at a glance <a href="#capabilities-and-use-cases" id="capabilities-and-use-cases"></a>

{% hint style="info" %}

* **Customer matching** — Email is the primary identifier; Perkville does not store an Acuity external member ID.
  {% endhint %}

* **Appointments** — Reward appointment attendance and pre-booking.

* **Purchases** — Reward qualifying orders.

* **Fulfillment** — Automatic redemptions and refund point deductions are not included in the listed integration.

Your configured rules determine which eligible activities award points and which workflows are enabled.

## Connecting Acuity

{% stepper %}
{% step %}

### Get your API credentials

Find your API credentials in Acuity [under Integrations](https://secure.acuityscheduling.com/app.php?action=settings\&key=api).

{% hint style="info" %}
Authentication to the API is done over SSL with [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), using your numeric User ID for the username and your API Key for the password. 401 Unauthorized will be returned on authentication failure.
{% endhint %}

{% embed url="<https://secure.acuityscheduling.com/app.php?action=settings&key=api>" %}
{% endstep %}

{% step %}

### Provide your Perkville representative with your credentials

Pass your numeric user ID and API key to your Perkville representative via a secure method, like [OneTimeSecret](https://onetimesecret.com/).

{% hint style="info" %}
If do not want to send your credentials, work with your Perkville representative to gain access to Middle, our integration platform.
{% endhint %}

{% embed url="<https://onetimesecret.com/>" %}
{% endstep %}
{% endstepper %}

## External member data

Perkville does not store an external member ID for Acuity. Email is the sole primary identifier used for the Acuity-Perkville connection.

## FAQ

### How are customers matched?

The connection uses email. Check that the appointment customer and Perkville profile use the intended email when investigating missing points.

See the [Acuity Scheduling partner profile](https://partners.perkville.com/partners/acuity-scheduling) for additional integration information.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integration-reference/acuity-scheduling.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
