- Category: fitness
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 18
- Triggers: 0
- Slug:
MINDBODY - Version: 20261030_00
Tools
Add Client to Class
Add Client to Class
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
Defaults true to validate without booking. Set false to commit; a validation-only response does not contain a usable visit ID.
Scheduled class ID verified as available and within its booking window using MINDBODY_LIST_CLASSES.
When true, request a booking email. API-key-only calls send no email regardless; defaults false.
When true, require a usable purchased pricing option. Defaults false to avoid unintended payment requirements.
Output
Create Client
Create Client
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
Active site-configured gender option. Mindbody rejects unsupported values unless the authenticated caller may create one.
Client birth date. Site settings may require it; sandbox site -99 required it during live probing.
Site-configured lead channel name from MINDBODY_LIST_ACCESSIBLE_SITES with include_lead_channels=true. Some sites require this value.
Complete emergency contact. Supply all four values when site requirements include EmergContact.
Output
Find Clients
Find Clients
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
Maximum clients to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Look up 1-20 exact known Mindbody client RSSIDs using API Key and Site ID. This action does not search or discover unknown clients.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Output
Get Appointment Availability
Get Appointment Availability
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
Maximum availability ranges in this page. Mindbody defaults to 100; no provider maximum has been verified.
Last site-local date to search. Keep the range narrow because broad requests are slower and less reliable.
First site-local date to search. Single-day YYYY-MM-DD boundaries are the live-verified shape.
Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
Appointment session type IDs from MINDBODY_LIST_SESSION_TYPES. Use a narrow set for predictable results.
Output
Get Client Complete Info
Get Client Complete Info
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
Known Mindbody client RSSID, such as an ID returned by MINDBODY_FIND_CLIENTS or MINDBODY_CREATE_CLIENT.
Output
List Accessible Sites
List Accessible Sites
List Active Session Times
List Active Session Times
Slug:
MINDBODY_LIST_ACTIVE_SESSION_TIMESList configured business-hour time slots and booking increments. This does not report actual appointment availability.Input Parameters
Maximum times to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
Schedule category to inspect. Defaults to All; Mindbody requires either this value or session_type_ids.
Output
List Appointments
List Appointments
Slug:
MINDBODY_LIST_APPOINTMENTSList booked staff appointments by client, date, appointment, location, or staff filters.Input Parameters
Maximum appointments to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
When true, populate each staff DisplayName using the site’s staff-name settings; otherwise Mindbody uses FirstName.
Output
List Classes
List Classes
Slug:
MINDBODY_LIST_CLASSESSearch scheduled class instances by date, location, program, session type, instructor, or known class IDs.Input Parameters
Maximum classes to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Latest class date and time to include. Mindbody’s class-date filter does not consider the class time.
Output
List Client Purchases
List Client Purchases
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
Maximum purchases to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Return purchases made on or after this date and time. Mindbody defaults to now, so set this explicitly to retrieve historical purchases.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Output
List Client Visits
List Client Visits
Slug:
MINDBODY_LIST_CLIENT_VISITSList a client’s class and appointment visit history within an optional date range.Input Parameters
Maximum visits to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to continue.
Numeric unique client ID. Provide this or client_id; when both are provided, Mindbody gives this ID precedence.
Output
List Enrollments
List Enrollments
Slug:
MINDBODY_LIST_ENROLLMENTSSearch scheduled multi-session enrollments such as workshops and events by date and business resource IDs.Input Parameters
Maximum enrollments to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Output
List Locations
List Locations
Slug:
MINDBODY_LIST_LOCATIONSList physical or online locations configured for the connected Mindbody site.Input Parameters
Maximum locations to return in this page. Mindbody defaults to 100; no maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Output
List Sales
List Sales
Slug:
MINDBODY_LIST_SALESList completed Mindbody sales by date range, sale, or payment method.Input Parameters
Maximum sales to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Output
List Session Types
List Session Types
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
Maximum session types to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Staff
List Staff
Slug:
MINDBODY_LIST_STAFFList basic staff directory records available to the connected API key, with optional role, activity, and ID filters.Input Parameters
Maximum staff records to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Filter by one or more staff categories: StaffViewable, AppointmentInstructor, ClassInstructor, Male, or Female.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
Output
Remove Client From Class
Remove Client From Class
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
Defaults true to validate without removing the visit. Set false only when the removal should be committed.
Exact positive VisitId returned by MINDBODY_ADD_CLIENT_TO_CLASS. It is always sent to avoid removing another visit.
When true, request a cancellation email. Defaults false; API-key-only calls send no email regardless.
Defaults false for an early cancellation. Set true only when the business intends a late-cancel outcome.
Output
Search Products
Search Products
Slug:
MINDBODY_SEARCH_PRODUCTSSearch the connected site’s read-only retail product catalog by text, IDs, categories, location, or online-sale status.Input Parameters
Maximum products to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.