List Appointments
acuity_scheduling.list_appointments
ActionBusiness appsconnection required
Calls the Acuity Scheduling API with the connection's credentials.
List appointments, optionally filtered by date, calendar, type or client.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Acuity Scheduling
- Secret shape
- {"user_id": "123456", "api_key": "…"}
- Config it needs
- calendar_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
11 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
max_results Maximum number of appointments to return in one call. | number | No | 100 | ≥ 1 | — |
min_date Only return appointments on or after this date, as YYYY-MM-DD. | string | No | — | matches \d{4}-\d{2}-\d{2} | 2026-01-01 |
max_date Only return appointments on or before this date, as YYYY-MM-DD. | string | No | — | matches \d{4}-\d{2}-\d{2} | 2026-01-31 |
calendar_id Numeric calendar id; overrides the calendar set on the connection. | string | No | — | — | 987654 |
appointment_type_id Only return appointments booked against this appointment type id. | string | No | — | — | 12345678 |
email Only return appointments for this client email address. | string | No | — | email format | — |
first_name Only return appointments whose client has this first name. | string | No | — | — | — |
last_name Only return appointments whose client has this last name. | string | No | — | — | — |
canceled Return canceled appointments instead of active ones. | boolean | No | false | — | — |
exclude_forms Leave intake form answers out of the response, which makes it much faster. | boolean | No | false | — | — |
direction Sort order of the returned appointments by start time. | string | No | DESC | one of "DESC", "ASC" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"appointment_type_id": "12345678",
"calendar_id": "987654",
"canceled": false,
"direction": "DESC",
"exclude_forms": false,
"max_date": "2026-01-31",
"max_results": 100,
"min_date": "2026-01-01"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
appointments The appointments Acuity returned, newest first by default. | array | — |
count How many appointments the response carried. | number | — |
{
"appointments": [],
"count": 0
}See List Appointments run in a workflow.
In a technical demo we add the Acuity Scheduling connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.