View as Markdown
Acuity Scheduling icon

Acuity Scheduling ACTION

Find Appointments by Client Info

Retrieves existing appointments using the client's information, allowing you to track all the appointments associated with a specific client. 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 Find Appointments by Client Info 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-find-appointments-by-client-info",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    acuity_scheduling: { authProvisionId: "apn_xxxxxxx" },
    calendarID: "Calendar ID",
    appointmentTypeID: "Appointment Type ID",
  },
})

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.

Find Appointments by Client Info inputs
Property Type Description
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
firstName First Name string
Filter appointments for client first name.
Optional
lastName Last Name string
Filter appointments for client last name.
Optional
email Email string
Filter appointments for client email address.
Optional
phone Phone string
Filter appointments for client phone.
Optional
customFields Custom Field object
Filter appointments matching a particular custom intake form field eg. ?field:1234=Hello
Optional
showAll Show All boolean
To retrieve both canceled and scheduled appointments.
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-find-appointments-by-client-info
Version
0.0.3
App
Acuity Scheduling
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes