View as Markdown
Mindbody icon

Mindbody ACTION

Get Appointments

Returns staff appointments, optionally filtered by date range, client, or staff member. Use clientId to show all appointments for a specific client — first use Search Clients to find their ID. Use staffId to filter by instructor. Date formats: YYYY-MM-DD (e.g., 2026-07-01). Without date filters, returns appointments from the current date forward (up to limit). See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mindbody 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: "mindbody-get-appointments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mindbody: { authProvisionId: "apn_xxxxxxx" },
    clientId: "Client ID",
    staffId: "Staff 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.

Get Appointments inputs
Property Type Description
clientId Client ID string
Filter appointments for a specific client. Use Search Clients to find the client ID.
Optional
staffId Staff ID string
Filter appointments for a specific staff member. Use List Staff to find staff IDs.
Optional
startDate Start Date string
Filter results on or after this date. Format: YYYY-MM-DD (e.g., 2026-01-01).
Optional
endDate End Date string
Filter results on or before this date. Format: YYYY-MM-DD (e.g., 2026-12-31).
Optional
limit Limit integer
Maximum number of results to return per page. Minimum 1, maximum 200. Defaults to 100.
Optional
offset Offset integer
Number of results to skip for pagination. Defaults to 0.
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
mindbody-get-appointments
Version
0.0.3
App
Mindbody
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes