Skip to main content
Mindbody logo
  • Category: fitness
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 18
  • Triggers: 0
  • Slug: MINDBODY
  • Version: 20261030_00

Tools

Slug: MINDBODY_ADD_CLIENT_TO_CLASSValidate or book a client into a class or waitlist. Check MINDBODY_LIST_CLASSES first. Defaults validate only, send no email, and require no payment; a real booking returns the visit ID needed for exact removal.

Input Parameters

boolean
Defaults true to validate without booking. Set false to commit; a validation-only response does not contain a usable visit ID.
integer
required
Scheduled class ID verified as available and within its booking window using MINDBODY_LIST_CLASSES.
boolean
When true, add the client to the waitlist instead of the class roster.
string
required
Existing client RSSID.
boolean
When true, request a booking email. API-key-only calls send no email regardless; defaults false.
boolean
When true, require a usable purchased pricing option. Defaults false to avoid unintended payment requirements.
integer
Purchased pricing-option ID to use when payment is required.
integer
Existing waitlist entry ID when moving a known waitlist entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_CREATE_CLIENTCreate one Mindbody client, or reactivate a matching inactive client when reactivate_inactive_client=true. Uses typed standard, emergency-contact, location, and custom-field inputs. Site settings can require otherwise optional fields; AddClient has no dry-run, and PartialSuccess means the client already exists, so never retry the whole request.

Input Parameters

string
Client email; first name, last name, and email participate in duplicate detection.
string
Active site-configured gender option. Mindbody rejects unsupported values unless the authenticated caller may create one.
object
Typed primary postal address fields to store on the client.
string
required
Client last name.
string
Client birth date. Site settings may require it; sandbox site -99 required it during live probing.
string
required
Client first name.
string
Client home phone number.
string
Site-configured lead channel name from MINDBODY_LIST_ACCESSIBLE_SITES with include_lead_channels=true. Some sites require this value.
string
Client mobile phone number.
array
Site-configured custom client values as typed ID and value records.
integer
Home location ID from MINDBODY_LIST_LOCATIONS. Omit to use the site’s default location.
object
Complete emergency contact. Supply all four values when site requirements include EmergContact.
boolean
When true, allow Mindbody to reactivate a matching inactive client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_FIND_CLIENTSLook up privacy-shaped clients by 1-20 exact known client RSSIDs using API Key and Site ID. This action cannot search for or discover unknown clients.

Input Parameters

integer
Maximum clients to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
array
required
Look up 1-20 exact known Mindbody client RSSIDs using API Key and Site ID. This action does not search or discover unknown clients.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_GET_APPOINTMENT_AVAILABILITYReturn actual BookableItems availability ranges for appointment session types. These are continuous staff windows, not guaranteed start times; intersect them with MINDBODY_LIST_ACTIVE_SESSION_TIMES before booking.

Input Parameters

integer
Maximum availability ranges in this page. Mindbody defaults to 100; no provider maximum has been verified.
string
required
Last site-local date to search. Keep the range narrow because broad requests are slower and less reliable.
array
Only return ranges for these IDs from MINDBODY_LIST_STAFF; omit for all eligible staff.
string
required
First site-local date to search. Single-day YYYY-MM-DD boundaries are the live-verified shape.
string
Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
array
Only return ranges at these IDs from MINDBODY_LIST_LOCATIONS.
integer
Existing appointment ID to exclude while finding replacement availability for a reschedule.
array
required
Appointment session type IDs from MINDBODY_LIST_SESSION_TYPES. Use a narrow set for predictable results.
boolean
When true, do not restrict ranges using the session type’s default duration.
boolean
When true, include resource availability needed by resource-dependent session types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_GET_CLIENT_COMPLETE_INFORetrieve a complete Mindbody client profile by known client RSSID, including requested services, contracts, memberships, and arrival programs.

Input Parameters

string
Include pricing options purchased on or before this date and time.
string
required
Known Mindbody client RSSID, such as an ID returned by MINDBODY_FIND_CLIENTS or MINDBODY_CREATE_CLIENT.
string
Include pricing options purchased on or after this date and time.
boolean
Return only active client services.
integer
Optional numeric unique client ID used by Mindbody in addition to the required RSSID.
boolean
Apply date filters to activation date instead of purchase date.
array
Related-data sections to include; omit to request all four sections.
boolean
Search associated sites in the same organization for pricing options.
boolean
Exclude inactive associated sites from cross-regional results.
integer
Zero-based associated-site offset; valid only when cross_regional_lookup is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_ACCESSIBLE_SITESList Mindbody sites accessible to the connected API key, or retrieve fuller details by filtering to one site ID.

Input Parameters

integer
Maximum sites to return in this page. Mindbody defaults to 100.
array
Site IDs to return. Omit to list every accessible site, or pass one ID to retrieve fuller details for that site.
string
Continuation cursor from a previous call; omit for the first page.
boolean
Whether to include lead channels for returned sites.
boolean
Whether to include each site’s per-staff-pricing setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_ACTIVE_SESSION_TIMESList configured business-hour time slots and booking increments. This does not report actual appointment availability.

Input Parameters

integer
Maximum times to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
string
Only include times at or before this time of day. Mindbody ignores the date component.
string
Only include times at or after this time of day. Mindbody ignores the date component.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
string ("All" | "Class" | "Enrollment" | "Appointment" | "Resource" | "Media" | "Arrival")
Schedule category to inspect. Defaults to All; Mindbody requires either this value or session_type_ids.
array
Only include slots for these session type IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_APPOINTMENTSList booked staff appointments by client, date, appointment, location, or staff filters.

Input Parameters

integer
Maximum appointments to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
string
End of the appointment date range as an ISO 8601 date-time; defaults to start_date.
string
Only return appointments booked for this client RSSID.
array
Only return appointments assigned to these staff IDs.
string
Start of the appointment date range as an ISO 8601 date-time; defaults to today.
string
Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
array
Only return appointments at these location IDs.
array
Only return appointments with these appointment IDs.
boolean
When true, populate each staff DisplayName using the site’s staff-name settings; otherwise Mindbody uses FirstName.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_CLASSESSearch scheduled class instances by date, location, program, session type, instructor, or known class IDs.

Input Parameters

integer
Maximum classes to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
array
Return these scheduled class instance IDs.
array
Only return classes taught by these staff IDs.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
array
Only return classes in these programs.
array
Only return classes at these location IDs.
array
Only return classes in these semesters.
string
Latest class date and time to include. Mindbody’s class-date filter does not consider the class time.
string
Only return classes modified at or after this date and time.
string
Earliest class date and time to include.
array
Only return classes with these session type IDs.
array
Only return classes from these class schedule IDs.
array
Only return classes with these class description IDs.
boolean
When true, omit canceled classes.
boolean
When true, omit classes outside their scheduling window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_CLIENT_PURCHASESList item-level purchases made by a specific Mindbody client within an optional date range. Omitted dates search from now through end of today; set start_date explicitly to retrieve historical purchases.

Input Parameters

integer
Maximum purchases to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
integer
Return only purchase records associated with this sale ID.
string
Return purchases made before this date and time; defaults to end of today.
string
required
Mindbody client RSSID whose purchases should be returned.
string
Return purchases made on or after this date and time. Mindbody defaults to now, so set this explicitly to retrieve historical purchases.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
integer
Numeric unique client ID used in addition to the required client RSSID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_CLIENT_VISITSList a client’s class and appointment visit history within an optional date range.

Input Parameters

integer
Maximum visits to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
string ("asc" | "desc")
Sort visits oldest first (asc) or newest first (desc).
string
Latest visit date and time to return; defaults to today’s date.
string
Mindbody client RSSID. Provide this or unique_client_id.
string
Earliest visit date and time to return; defaults to end_date.
string
Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to continue.
boolean
When true, return only visits that have not been paid for.
integer
Numeric unique client ID. Provide this or client_id; when both are provided, Mindbody gives this ID precedence.
boolean
When true, include past and scheduled visits across the client’s region.
integer
Number of client-associated sites to skip during the lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_ENROLLMENTSSearch scheduled multi-session enrollments such as workshops and events by date and business resource IDs.

Input Parameters

integer
Maximum enrollments to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
string
Return active enrollments occurring on or before this date. Mindbody defaults to start_date.
array
Only return enrollments taught by these staff members.
string
Return active enrollments occurring on or after this date. Mindbody defaults to today.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
array
Only return enrollments in these programs.
array
Only return enrollments at these locations.
array
Only return enrollments with these session types.
array
Return these enrollment class schedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_LOCATIONSList physical or online locations configured for the connected Mindbody site.

Input Parameters

integer
Maximum locations to return in this page. Mindbody defaults to 100; no maximum has been verified.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_SALESList completed Mindbody sales by date range, sale, or payment method.

Input Parameters

integer
Maximum sales to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
integer
Only return the sale with this sale ID.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
integer
Only return sales paid with this Mindbody payment method ID.
string
Return sales completed before this date and time.
string
Return sales completed after this date and time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_SESSION_TYPESList service and session types configured at the connected Mindbody site, including IDs used by schedule and availability searches.

Input Parameters

integer
Maximum session types to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
boolean
When true, return only session types that can be booked online.
array
Only return session types belonging to these program IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_LIST_STAFFList basic staff directory records available to the connected API key, with optional role, activity, and ID filters.

Input Parameters

integer
Maximum staff records to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
array
Filter by one or more staff categories: StaffViewable, AppointmentInstructor, ClassInstructor, Male, or Female.
array
Only return these staff IDs.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
boolean
When true, include inactive as well as active staff members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_REMOVE_CLIENT_FROM_CLASSValidate or remove one exact Mindbody class visit. Defaults to validation, early cancellation, and no email. A committed response can be stale, so verify removal separately using the exact VisitId.

Input Parameters

boolean
Defaults true to validate without removing the visit. Set false only when the removal should be committed.
integer
required
Scheduled class ID containing the exact visit to remove.
integer
required
Exact positive VisitId returned by MINDBODY_ADD_CLIENT_TO_CLASS. It is always sent to avoid removing another visit.
string
required
Client RSSID associated with the exact visit.
boolean
When true, request a cancellation email. Defaults false; API-key-only calls send no email regardless.
boolean
Defaults false for an early cancellation. Set true only when the business intends a late-cancel outcome.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINDBODY_SEARCH_PRODUCTSSearch the connected site’s read-only retail product catalog by text, IDs, categories, location, or online-sale status.

Input Parameters

integer
Maximum products to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
integer
Location used to calculate returned product tax. Omit to use the online store.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
array
Filter by product barcode IDs. Values are strings so leading zeros are preserved.
string
Search products by a text term.
boolean
When true, return only products that can be sold online.
array
Filter by revenue category IDs.
array
Filter by subcategory IDs.
array
Filter by secondary category IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not