View as Markdown
Acuity Scheduling icon

Acuity Scheduling ACTION

Get Appointments

Return a list of appointments. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Acuity Scheduling account once, then configure and run Get Appointments from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "acuity_scheduling-get-appointments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    acuity_scheduling: { authProvisionId: "apn_xxxxxxx" },
    minDate: "Min Date",
    maxDate: "Max Date",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Appointments inputs
Property Type Description
minDate Min Date string
Show appointments after this date (YYYY-MM-DD)
Optional
maxDate Max Date string
Show appointments before this date (YYYY-MM-DD)
Optional
calendarId Calendar ID string
Show only appointments on calendar with specified ID.
Optional Dynamic
appointmentTypeId Appointment Type ID string
Show only appointments of this type.
Optional Dynamic
canceled Canceled boolean
Show only canceled appointments
Optional
showall Show All boolean
Show both canceled and scheduled appointments
Optional
excludeForms Exclude Forms boolean
Don't include intake forms in the response object (speeds up the response)
Optional
email Email string
Filter by client email address
Optional
firstName First Name string
Filter by client first name
Optional
lastName Last Name string
Filter by client last name
Optional
phone Phone string
Filter by client phone number
Optional
max Max Results integer
Maximum number of appointments to return
Optional
direction Direction string
Sort direction
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
acuity_scheduling-get-appointments
Version
0.0.2
App
Acuity Scheduling
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes