View as Markdown
Mindbody icon

Mindbody ACTION

List Staff

Returns staff members at the studio, including their IDs, names, bio, and role assignments (e.g., ClassTeacher, AppointmentInstructor). Use this to discover staffId values needed by Book Appointment and Get Classes. Filter by filters to find staff with a specific role (e.g., AppointmentInstructor). See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mindbody account once, then configure and run List Staff 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-list-staff",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mindbody: { authProvisionId: "apn_xxxxxxx" },
    filters: "Role Filters",
    locationId: 10,
  },
})

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.

List Staff inputs
Property Type Description
filters Role Filters string
Comma-separated list of role filters to narrow results. Valid values: ClassTeacher, AppointmentInstructor, Male, Female. Example: AppointmentInstructor.
Optional
locationId Location ID integer
The ID of the location (studio). Use Get Site Info to discover valid location IDs.
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-list-staff
Version
0.0.3
App
Mindbody
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes