> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Mindbody

> Mindbody provides scheduling, client management, commerce, and business operations software for fitness, wellness, and beauty businesses.

![Mindbody logo](https://mintcdn.com/composio-preview/9YPuzjEU4UlMnwGq/images/toolkits/mindbody.svg?fit=max\&auto=format\&n=9YPuzjEU4UlMnwGq\&q=85\&s=836985db84932223cbc0f83b6428207e)

* **Category:** fitness
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 18
* **Triggers:** 0
* **Slug:** `MINDBODY`
* **Version:** 20261030\_00

## Tools

> [accordion] Add Client to Class
>
> **Slug:** `MINDBODY_ADD_CLIENT_TO_CLASS`
>
> Validate 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
>
> **test** `boolean`
>
> Defaults true to validate without booking. Set false to commit; a validation-only response does not contain a usable visit ID.
>
> **class\_id** `integer` *required*
>
> Scheduled class ID verified as available and within its booking window using MINDBODY\_LIST\_CLASSES.
>
> **waitlist** `boolean`
>
> When true, add the client to the waitlist instead of the class roster.
>
> **client\_id** `string` *required*
>
> Existing client RSSID.
>
> **send\_email** `boolean`
>
> When true, request a booking email. API-key-only calls send no email regardless; defaults false.
>
> **require\_payment** `boolean`
>
> When true, require a usable purchased pricing option. Defaults false to avoid unintended payment requirements.
>
> **client\_service\_id** `integer`
>
> Purchased pricing-option ID to use when payment is required.
>
> **waitlist\_entry\_id** `integer`
>
> Existing waitlist entry ID when moving a known waitlist entry.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Client
>
> **Slug:** `MINDBODY_CREATE_CLIENT`
>
> Create 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
>
> **email** `string`
>
> Client email; first name, last name, and email participate in duplicate detection.
>
> **gender** `string`
>
> Active site-configured gender option. Mindbody rejects unsupported values unless the authenticated caller may create one.
>
> **address** `object`
>
> Typed primary postal address fields to store on the client.
>
> **last\_name** `string` *required*
>
> Client last name.
>
> **birth\_date** `string`
>
> Client birth date. Site settings may require it; sandbox site -99 required it during live probing.
>
> **first\_name** `string` *required*
>
> Client first name.
>
> **home\_phone** `string`
>
> Client home phone number.
>
> **referred\_by** `string`
>
> Site-configured lead channel name from MINDBODY\_LIST\_ACCESSIBLE\_SITES with include\_lead\_channels=true. Some sites require this value.
>
> **mobile\_phone** `string`
>
> Client mobile phone number.
>
> **custom\_fields** `array`
>
> Site-configured custom client values as typed ID and value records.
>
> **home\_location\_id** `integer`
>
> Home location ID from MINDBODY\_LIST\_LOCATIONS. Omit to use the site's default location.
>
> **emergency\_contact** `object`
>
> Complete emergency contact. Supply all four values when site requirements include EmergContact.
>
> **reactivate\_inactive\_client** `boolean`
>
> When true, allow Mindbody to reactivate a matching inactive client.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Clients
>
> **Slug:** `MINDBODY_FIND_CLIENTS`
>
> Look 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
>
> **limit** `integer`
>
> Maximum clients to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **client\_ids** `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.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Appointment Availability
>
> **Slug:** `MINDBODY_GET_APPOINTMENT_AVAILABILITY`
>
> Return 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
>
> **limit** `integer`
>
> Maximum availability ranges in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **end\_date** `string` *required*
>
> Last site-local date to search. Keep the range narrow because broad requests are slower and less reliable.
>
> **staff\_ids** `array`
>
> Only return ranges for these IDs from MINDBODY\_LIST\_STAFF; omit for all eligible staff.
>
> **start\_date** `string` *required*
>
> First site-local date to search. Single-day YYYY-MM-DD boundaries are the live-verified shape.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **location\_ids** `array`
>
> Only return ranges at these IDs from MINDBODY\_LIST\_LOCATIONS.
>
> **appointment\_id** `integer`
>
> Existing appointment ID to exclude while finding replacement availability for a reschedule.
>
> **session\_type\_ids** `array` *required*
>
> Appointment session type IDs from MINDBODY\_LIST\_SESSION\_TYPES. Use a narrow set for predictable results.
>
> **ignore\_default\_session\_length** `boolean`
>
> When true, do not restrict ranges using the session type's default duration.
>
> **include\_resource\_availability** `boolean`
>
> When true, include resource availability needed by resource-dependent session types.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Client Complete Info
>
> **Slug:** `MINDBODY_GET_CLIENT_COMPLETE_INFO`
>
> Retrieve a complete Mindbody client profile by known client RSSID, including requested services, contracts, memberships, and arrival programs.
>
> #### Input Parameters
>
> **end\_date** `string`
>
> Include pricing options purchased on or before this date and time.
>
> **client\_id** `string` *required*
>
> Known Mindbody client RSSID, such as an ID returned by MINDBODY\_FIND\_CLIENTS or MINDBODY\_CREATE\_CLIENT.
>
> **start\_date** `string`
>
> Include pricing options purchased on or after this date and time.
>
> **show\_active\_only** `boolean`
>
> Return only active client services.
>
> **unique\_client\_id** `integer`
>
> Optional numeric unique client ID used by Mindbody in addition to the required RSSID.
>
> **use\_activate\_date** `boolean`
>
> Apply date filters to activation date instead of purchase date.
>
> **required\_client\_data** `array`
>
> Related-data sections to include; omit to request all four sections.
>
> **cross\_regional\_lookup** `boolean`
>
> Search associated sites in the same organization for pricing options.
>
> **exclude\_inactive\_sites** `boolean`
>
> Exclude inactive associated sites from cross-regional results.
>
> **client\_associated\_sites\_offset** `integer`
>
> Zero-based associated-site offset; valid only when cross\_regional\_lookup is true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Accessible Sites
>
> **Slug:** `MINDBODY_LIST_ACCESSIBLE_SITES`
>
> List Mindbody sites accessible to the connected API key, or retrieve fuller details by filtering to one site ID.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum sites to return in this page. Mindbody defaults to 100.
>
> **site\_ids** `array`
>
> Site IDs to return. Omit to list every accessible site, or pass one ID to retrieve fuller details for that site.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **include\_lead\_channels** `boolean`
>
> Whether to include lead channels for returned sites.
>
> **include\_per\_staff\_pricing** `boolean`
>
> Whether to include each site's per-staff-pricing setting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Active Session Times
>
> **Slug:** `MINDBODY_LIST_ACTIVE_SESSION_TIMES`
>
> List configured business-hour time slots and booking increments. This does not report actual appointment availability.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum times to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **end\_time** `string`
>
> Only include times at or before this time of day. Mindbody ignores the date component.
>
> **start\_time** `string`
>
> Only include times at or after this time of day. Mindbody ignores the date component.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **schedule\_type** `string ("All" | "Class" | "Enrollment" | "Appointment" | "Resource" | "Media" | "Arrival")`
>
> Schedule category to inspect. Defaults to All; Mindbody requires either this value or session\_type\_ids.
>
> **session\_type\_ids** `array`
>
> Only include slots for these session type IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Appointments
>
> **Slug:** `MINDBODY_LIST_APPOINTMENTS`
>
> List booked staff appointments by client, date, appointment, location, or staff filters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum appointments to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **end\_date** `string`
>
> End of the appointment date range as an ISO 8601 date-time; defaults to start\_date.
>
> **client\_id** `string`
>
> Only return appointments booked for this client RSSID.
>
> **staff\_ids** `array`
>
> Only return appointments assigned to these staff IDs.
>
> **start\_date** `string`
>
> Start of the appointment date range as an ISO 8601 date-time; defaults to today.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **location\_ids** `array`
>
> Only return appointments at these location IDs.
>
> **appointment\_ids** `array`
>
> Only return appointments with these appointment IDs.
>
> **use\_site\_settings\_staff\_name** `boolean`
>
> When true, populate each staff DisplayName using the site's staff-name settings; otherwise Mindbody uses FirstName.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Classes
>
> **Slug:** `MINDBODY_LIST_CLASSES`
>
> Search scheduled class instances by date, location, program, session type, instructor, or known class IDs.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum classes to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **class\_ids** `array`
>
> Return these scheduled class instance IDs.
>
> **staff\_ids** `array`
>
> Only return classes taught by these staff IDs.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **program\_ids** `array`
>
> Only return classes in these programs.
>
> **location\_ids** `array`
>
> Only return classes at these location IDs.
>
> **semester\_ids** `array`
>
> Only return classes in these semesters.
>
> **end\_date\_time** `string`
>
> Latest class date and time to include. Mindbody's class-date filter does not consider the class time.
>
> **modified\_since** `string`
>
> Only return classes modified at or after this date and time.
>
> **start\_date\_time** `string`
>
> Earliest class date and time to include.
>
> **session\_type\_ids** `array`
>
> Only return classes with these session type IDs.
>
> **class\_schedule\_ids** `array`
>
> Only return classes from these class schedule IDs.
>
> **class\_description\_ids** `array`
>
> Only return classes with these class description IDs.
>
> **hide\_canceled\_classes** `boolean`
>
> When true, omit canceled classes.
>
> **within\_scheduling\_window** `boolean`
>
> When true, omit classes outside their scheduling window.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Purchases
>
> **Slug:** `MINDBODY_LIST_CLIENT_PURCHASES`
>
> List 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
>
> **limit** `integer`
>
> Maximum purchases to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **sale\_id** `integer`
>
> Return only purchase records associated with this sale ID.
>
> **end\_date** `string`
>
> Return purchases made before this date and time; defaults to end of today.
>
> **client\_id** `string` *required*
>
> Mindbody client RSSID whose purchases should be returned.
>
> **start\_date** `string`
>
> Return purchases made on or after this date and time. Mindbody defaults to now, so set this explicitly to retrieve historical purchases.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **unique\_client\_id** `integer`
>
> Numeric unique client ID used in addition to the required client RSSID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Client Visits
>
> **Slug:** `MINDBODY_LIST_CLIENT_VISITS`
>
> List a client's class and appointment visit history within an optional date range.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum visits to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **order** `string ("asc" | "desc")`
>
> Sort visits oldest first (asc) or newest first (desc).
>
> **end\_date** `string`
>
> Latest visit date and time to return; defaults to today's date.
>
> **client\_id** `string`
>
> Mindbody client RSSID. Provide this or unique\_client\_id.
>
> **start\_date** `string`
>
> Earliest visit date and time to return; defaults to end\_date.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **unpaids\_only** `boolean`
>
> When true, return only visits that have not been paid for.
>
> **unique\_client\_id** `integer`
>
> Numeric unique client ID. Provide this or client\_id; when both are provided, Mindbody gives this ID precedence.
>
> **cross\_regional\_lookup** `boolean`
>
> When true, include past and scheduled visits across the client's region.
>
> **client\_associated\_sites\_offset** `integer`
>
> Number of client-associated sites to skip during the lookup.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Enrollments
>
> **Slug:** `MINDBODY_LIST_ENROLLMENTS`
>
> Search scheduled multi-session enrollments such as workshops and events by date and business resource IDs.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum enrollments to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **end\_date** `string`
>
> Return active enrollments occurring on or before this date. Mindbody defaults to start\_date.
>
> **staff\_ids** `array`
>
> Only return enrollments taught by these staff members.
>
> **start\_date** `string`
>
> Return active enrollments occurring on or after this date. Mindbody defaults to today.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **program\_ids** `array`
>
> Only return enrollments in these programs.
>
> **location\_ids** `array`
>
> Only return enrollments at these locations.
>
> **session\_type\_ids** `array`
>
> Only return enrollments with these session types.
>
> **class\_schedule\_ids** `array`
>
> Return these enrollment class schedules.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Locations
>
> **Slug:** `MINDBODY_LIST_LOCATIONS`
>
> List physical or online locations configured for the connected Mindbody site.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum locations to return in this page. Mindbody defaults to 100; no maximum has been verified.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sales
>
> **Slug:** `MINDBODY_LIST_SALES`
>
> List completed Mindbody sales by date range, sale, or payment method.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum sales to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **sale\_id** `integer`
>
> Only return the sale with this sale ID.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **payment\_method\_id** `integer`
>
> Only return sales paid with this Mindbody payment method ID.
>
> **end\_sale\_date\_time** `string`
>
> Return sales completed before this date and time.
>
> **start\_sale\_date\_time** `string`
>
> Return sales completed after this date and time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Session Types
>
> **Slug:** `MINDBODY_LIST_SESSION_TYPES`
>
> List service and session types configured at the connected Mindbody site, including IDs used by schedule and availability searches.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum session types to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **online\_only** `boolean`
>
> When true, return only session types that can be booked online.
>
> **program\_ids** `array`
>
> Only return session types belonging to these program IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Staff
>
> **Slug:** `MINDBODY_LIST_STAFF`
>
> List basic staff directory records available to the connected API key, with optional role, activity, and ID filters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum staff records to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **filters** `array`
>
> Filter by one or more staff categories: StaffViewable, AppointmentInstructor, ClassInstructor, Male, or Female.
>
> **staff\_ids** `array`
>
> Only return these staff IDs.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **include\_inactive** `boolean`
>
> When true, include inactive as well as active staff members.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Client From Class
>
> **Slug:** `MINDBODY_REMOVE_CLIENT_FROM_CLASS`
>
> Validate 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
>
> **test** `boolean`
>
> Defaults true to validate without removing the visit. Set false only when the removal should be committed.
>
> **class\_id** `integer` *required*
>
> Scheduled class ID containing the exact visit to remove.
>
> **visit\_id** `integer` *required*
>
> Exact positive VisitId returned by MINDBODY\_ADD\_CLIENT\_TO\_CLASS. It is always sent to avoid removing another visit.
>
> **client\_id** `string` *required*
>
> Client RSSID associated with the exact visit.
>
> **send\_email** `boolean`
>
> When true, request a cancellation email. Defaults false; API-key-only calls send no email regardless.
>
> **late\_cancel** `boolean`
>
> Defaults false for an early cancellation. Set true only when the business intends a late-cancel outcome.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Products
>
> **Slug:** `MINDBODY_SEARCH_PRODUCTS`
>
> Search the connected site's read-only retail product catalog by text, IDs, categories, location, or online-sale status.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum products to return in this page. Mindbody defaults to 100; no provider maximum has been verified.
>
> **location\_id** `integer`
>
> Location used to calculate returned product tax. Omit to use the online store.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
>
> **product\_ids** `array`
>
> Filter by product barcode IDs. Values are strings so leading zeros are preserved.
>
> **search\_text** `string`
>
> Search products by a text term.
>
> **sell\_online** `boolean`
>
> When true, return only products that can be sold online.
>
> **category\_ids** `array`
>
> Filter by revenue category IDs.
>
> **sub\_category\_ids** `array`
>
> Filter by subcategory IDs.
>
> **secondary\_category\_ids** `array`
>
> Filter by secondary category IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
