Acuity Scheduling is an online appointment scheduling platform that allows businesses to manage bookings, calendars, and client information. This connector extracts data about appointments, calendars, appointment types, and products from your Acuity Scheduling account.Documentation Index
Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
Use this file to discover all available pages before exploring further.
Configuring Acuity Scheduling as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Acuity Scheduling option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
To connect Acuity Scheduling, you need:- User ID: Your numeric Acuity Scheduling User ID.
- API Key: Your Acuity Scheduling API Key.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis:- Appointments
- Calendars
- Appointment Types
- Products
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated. Optionally, you can define some additional settings:- Start Date (optional): The earliest date to fetch appointments from. Only appointments on or after this date will be extracted.
- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Below you’ll find all available data streams from Acuity Scheduling and their corresponding fields:Appointments
Appointments
Scheduled appointments with client details, pricing, calendar assignment, and status information. Fetches both active and canceled appointments. Supports incremental sync based on appointment datetime.
| 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 | string | Associated addon IDs (JSON) |
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 |
Data Model
The following diagram illustrates the basic relationships between the core data streams in Acuity Scheduling.Skills for agents
Download Acuity Scheduling skills file
Acuity Scheduling connector documentation as plain markdown, for use in AI agent contexts.