View as Markdown
Mindbody icon

Mindbody ACTION

Search Clients

Searches for client (member) records by name, email address, or phone number. Returns client IDs, contact details, and membership status. Use this to find a client's ID before calling Get Client Details, Get Appointments, or Book Appointment. The searchText matches against first name, last name, email, and phone — partial matches are supported. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mindbody account once, then configure and run Search Clients 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-search-clients",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mindbody: { authProvisionId: "apn_xxxxxxx" },
    searchText: "Search Text",
    limit: 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.

Search Clients inputs
Property Type Description
searchText Search Text string
Text to search for. Matches against first name, last name, email, and phone. Example: Jerry Seinfeld or jerry@example.com.
Required
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-search-clients
Version
0.0.3
App
Mindbody
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes