Skip to main content

Acuity Scheduling

Category: EHR & Practice Mgmt
Node id: acuity-scheduling

Standards: GDPR, HIPAA-eligible

Connects to Acuity Scheduling (Squarespace) REST API v1 for appointments, clients, and availability. Tier 1 — open public API, self-service signup.

What it does​

  • List, get, create, and cancel appointments
  • List clients and appointment types
  • Query slot availability
  • OAuth2 Bearer and HTTP Basic authentication

Use cases​

  • Sync practice scheduling data into FHIR Appointment resources
  • Trigger downstream pipelines when an Acuity appointment is created
  • Reconcile no-show rates against EHR encounters

Runtime​

  • Performance tier: fast

Input ports​

NameTypeRequiredDescription
appointment_idtextNoAppointment ID for get/cancel
appointmentjsonNoAppointment object for create
queryjsonNoOptional query string parameters

Output ports​

NameTypeRequiredDescription
resultjsonNoParsed JSON response payload from the vendor API
metadatajsonNoOperation, HTTP status code, and content length
successbooleanNoTrue if HTTP 2xx

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Base URLbase_urlstringNohttps://acuityscheduling.com/api/v1Acuity API base URL
OperationoperationenumYeslist_appointmentslist_appointments, get_appointment, create_appointment, cancel_appointment, list_clients, list_appointment_types, list_availability

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Typeauth_typeenumNobasicbasic, oauth2
User IDuser_idstringNoAcuity User ID (basic auth)
API Keyapi_keysecretNoAcuity API Key (basic auth)
OAuth2 Access Tokenaccess_tokensecretNoOAuth2 Bearer token

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Min Datemin_datestringNoFilter appointments from this date (YYYY-MM-DD)
Max Datemax_datestringNoFilter appointments up to this date

Errors​

CodeDescription
ACUITY_AUTH_FAILEDAuthentication credentials missing or rejected
ACUITY_REQUEST_FAILEDHTTP request to Acuity failed

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Something unclear? Send documentation feedback by email.