Configuration
Add account access
To connect Acuity Scheduling, you need:
- User ID: Your numeric Acuity Scheduling User ID.
- API Key: Your Acuity Scheduling API Key.
Select streams
Choose which data streams to sync:
- Appointments: All scheduled appointments with client info, pricing, and status (supports incremental sync).
- Calendars: Staff calendars with location and timezone info.
- Appointment Types: Services and appointment types with pricing and duration.
- Products: Packages and product offerings.
Configure data source
Fill in the required configuration:
- User ID (required): Your numeric Acuity Scheduling User ID.
- API Key (required): Your Acuity Scheduling API Key.
- Start Date (optional): The earliest date to fetch appointments from. Only appointments on or after this date will be extracted.
Streams and Fields
Appointments
Appointments
Scheduled appointments with client details, pricing, calendar assignment, and status information. Supports incremental sync based on appointment date.
| Field | Type | Description |
|---|---|---|
id | integer | Unique appointment identifier |
firstName | string | Client first name |
lastName | string | Client last name |
phone | string | Client phone number |
email | string | Client email address |
date | string | Formatted appointment date |
time | string | Formatted start time |
endTime | string | Formatted end time |
dateCreated | string | Appointment creation date |
datetime | datetime | ISO 8601 appointment datetime (replication key) |
price | string | Appointment price |
paid | string | Payment status (yes/no) |
amountPaid | string | Amount paid |
type | string | Appointment type name |
appointmentTypeID | integer | Appointment type identifier |
addonIDs | array | Associated addon IDs |
classID | integer | Class ID if applicable |
duration | string | Duration in minutes |
calendar | string | Calendar name |
calendarID | integer | Calendar identifier |
canClientCancel | boolean | Whether client can cancel |
canClientReschedule | boolean | Whether client can reschedule |
location | string | Appointment location |
certificate | string | Certificate code if used |
confirmationPage | string | Confirmation URL |
formsText | string | Form summary text |
notes | string | Appointment notes |
timezone | string | Client timezone |
forms | string | Intake form responses (JSON) |
labels | string | Applied labels (JSON) |
noShow | boolean | Marked as no-show |
scheduledBy | string | Admin who scheduled it |
canceled | boolean | Whether appointment is canceled |
Calendars
Calendars
Staff calendars with contact and location information.
| Field | Type | Description |
|---|---|---|
id | integer | Unique calendar identifier |
name | string | Calendar name |
email | string | Associated email address |
replyTo | string | Reply-to email address |
description | string | Calendar description |
location | string | Calendar location |
timezone | string | Timezone identifier |
Appointment Types
Appointment Types
Service types and appointment configurations with pricing and duration.
| Field | Type | Description |
|---|---|---|
id | integer | Unique appointment type identifier |
active | boolean | Whether the appointment type is active |
name | string | Appointment type name |
description | string | Appointment type description |
duration | integer | Duration in minutes |
price | string | Price in account currency |
category | string | Category of the appointment type |
color | string | Display color |
private | boolean | Whether the type is private |
type | string | Service type (service, class, series) |
classSize | integer | Maximum class capacity |
paddingAfter | integer | Buffer time after appointment (minutes) |
paddingBefore | integer | Buffer time before appointment (minutes) |
calendarIDs | array | Associated calendar identifiers |
Products
Products
Packages and product offerings with pricing and configuration.
| Field | Type | Description |
|---|---|---|
id | integer | Unique product identifier |
name | string | Product name |
description | string | Product description |
price | string | Price in account currency |
type | string | Product type (product, appointments, minutes) |
hidden | boolean | Whether the product is hidden from the store |
expires | integer | Days until package expiration |
appointmentTypeIDs | array | Associated appointment type IDs |
appointmentTypeCounts | string | Appointment counts by type (JSON) |
minutes | integer | Minutes included in package |