/
MI
mindbodyonline
/
REST API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 2w ago
View markdown
mindbodyonline
REST API
get
Gets Visitor status for current user login if user is visitor type staff or not
latest
Swagger 2.0
2026-08-10
143
234
301.7 KB
dc2736850e42
Rest
143
post
Used to help close open ended supensions on autopays for a region
post
Used to help create open ended supensions on autopays for a region
post
Used to help close open ended supensions on autopays for a subscriber
post
Used to help create open ended supensions on autopays for a subscriber
get
Gets calendar events for a given staff. Staff members can only retrieve their own calendar events. Endpoint also supports Service Identity.
get
Retrieve Category by verical ids
get
Retrieves a business's closures for a given start and end date
get
Get all features for the studio
patch
Patch a Feature resource
get
Retrieve a list of promo codes
post
Create a new promo code
put
Update an existing promo code
get
Get calendar event details for a sale.
get
Retrieve a list of sales details records
post
Request takes a list of appointment Ids. Checks if the appointment and current series exist, and then apply payment.
get
Returns the Appointment Request identified by the ID.
post
Approves a single or multiple request(s) and sends the appointment request confirmation email. Takes a list of appointment requests which includes AppointmentRequestReference, StaffReference, AppointmentTypeReference, Range, ConsumerReference, LocationReference, ResourceReferences, AvailabilityReference.
post
Deny a single or multiple appointment requests and sends the appointment request denial email. Takes a list of appointment request Ids.
post
Deny multiple appointment requests in a single operation with optional consumer notification control. This endpoint processes appointment requests and provides detailed error reporting.
get
Gets appointment details. Takes a list of appointment ids and returns dictionary of appointment and its related objects.
post
Adds Addons.
get
Gets add-on details of a list of appointments Takes a list of appointment Ids and returns dictionary of add-on details keyed by appointment Id.
post
Updates the appointment status to completed
post
Delete Addons
get
Gets add-on details of an addon Takes a query string of addon Ids and returns dictionary of add-on details keyed by parent appointment Id.
post
Modifies multiple appointments. Takes a list of appointment objects and sendEmail returns success or errors.
post
Updates the appointment status to completed
post
Modifies multiple appointments. Takes a list of appointment objects and sendEmail returns success or errors.
post
Books a recurring appointment group based on the options and returns list of AppointmentIds
post
Validates recurring appointment options and returns list of conflicts that might happen based on the options
get
Gets availability schedule details. Takes a list of availability ids and returns availability schedule objects.
post
Takes a list of AvailabilitySchedules and adds them to the schedule. Returns a list of AvailabilitySchedules with Id. The following are required parameters: DaysOfWeek,StartTime,EndTime,StartDate,EndDate
post
Takes a list of AvailabilitySchedules and updates availabilityscheduleGroup. Returns a list of AvailabilitySchedules with GroupId
post
Searches for availability schedule details for specific staff.
get
Gets class instance details for the given instance.
get
Gets class instance details for the given instance.
get
Gets class instance details for the given instance.
get
Gets upcoming classes for the subscriber
get
Gets enrollment details for a subscriber.
post
Gets booking templates based on passed in consumer ID and the max days to get. This call is intended to help make booking easier by providing templates that have much of the information, needed to make an appointment, already filled out. The templates are built based on the consumer's past appointment activity.
get
Retrieve Category by category ids
get
Get a list of clients with services on date provided.
get
Returns the current series available on account for a user If you're checking a date range and any 1 of those dates cannot be paid for by the pricing option, the call will return "Invalid data"
get
Gets a list of all active consumer mode appointment types if appointment type Id is not provided. Gets a specific appointment type if Id is specified.
get
Gets a list of all active consumer mode appointment types if appointment type Id is not provided. Gets a specific appointment type if Id is specified.
get
This action returns a list of locations that can schedule appointments.
post
Books single or multiple appointments and sends booking confirmation email. Makes single or multiple appointment requests and sends appointment requested email if booking option is turned off. Books and applies payment for single appointment if payment is required and sends booking confirmation email. Location Id,StaffReference, AppointmentTypeReference, Range is required. checkVerified is a boolean used for Connect on versions above 2.0.4. Returns booked appointment details
get
List of bookable time ranges, appointment types, and staff appointment type details. Location Id,Appointment type Id is required. Staff id is optional. Can pass multiple staffId params Date part is requried, time part is optional.
post
Books single or multiple appointments with add-ons.
get
Gets appointment types for a specific staff at a specific location
get
Gets appointment types for a specific staff.
get
Gets the sales data by category for the specified month
get
Get's the summary data for the given criteria
get
Gets the monthly active member data between the specified dates
get
Get the monthly attendance data between the specified dates
get
Gets the monthly online booking data between the specified dates
get
Gets the monthly sales data between the specified dates
get
Retrieve a list of all amenities that can be applied to a location.
get
Retrieve a list of all BusinessIdentifiesAs that can be applied to a location.
get
Retrieve a list of all CrowdSafeAs that can be applied to a location.
get
Retrieve a list of all amenities assigned to the location indicated.
put
Updates the amenities list assigned to a specific location to the amenities specified in the body.
get
Retrieve a list of all BusinessIdentifiesAs assigned to the location indicated.
put
Updates the BusinessIdentifiesAs list assigned to a specific location to the BusinessIdentifiesAs specified in the body.
get
Retrieve a list of all CrowdSafeAs assigned to the location indicated.
put
Updates the CrowdSafeAs list assigned to a specific location to the CrowdSafeAs specified in the body.
get
Retrieve a list of all amenities that can be applied to a location.
get
Retrieve a list of all BusinessIdentifiesAs that can be applied to a location.
get
Retrieve a list of all CrowdSafeAs that can be applied to a location.
get
Find the signature image url for a specified sale.
post
Uploads a liability waiver for a consumer. Expects a file of type pdf,jpg,jpeg,tif,tiff,png,doc,docx,bmp,txt,rtf,xlsx,xls,gif,zip,ppt,pptx, or mov and size of less than 4194304 bytes. The name of the file is irrelevant.
post
Endpoint used to process feedback requests.
post
Callback registered with the live_stream API to ensure that a user is eligible join a live stream session
post
Callback registered with the live_stream API to ensure that a user is eligible join a live stream session
get
Gets a list of mobile application versions. Can return version information specifically for a given product and platform. Authorization Header not required but preferred
get
Fetches network metric metadata filtered based on the provided request.
get
This endpoint will get the shortened privacy preferences URL for a Subscriber or MB App user If the url is for a subscriber user, use the subscriberId and the consumerId. If the url is for an MB App user, use the user email.
get
Get inventory items
get
Finds and returns all of the Services for the current subscriber.
post
Endpoint used to report MB class review abuse.
get
Gets settings from General Setup and Options page.
get
Gets AppointmentOptions for a Subscriber
get
Retrieves a subscriber's Auto Email Settings
get
Gets custom gender options for a specific subscriber.
get
Gets list of all available countries.
get
Gets a list of countries with the associated territories (states or provinces).
get
Retrieves a subscriber's Liability Release Waiver
put
Replaces a subscriber's Liability Release Waiver with the given resource.
post
Adds a subscriber's Liability Release Waiver
get
List of tax tables. Every location may have up to a maximum of 5 taxes. Tax values are represented as decimals.
put
Replaces tax tables with the given resource. Each location may have up to a maximum of 5 taxes.
get
The ping endpoint for the application
get
Endpoint for readiness probe to check mandatory services are available
get
Check status
put
Updates the SMTP settings for the subscriber
post
Sends a test email to the provided address with the given custom settings
get
Finds business information for a business.
put
Replaces the business information for a business with the given resource.
get
Finds Owner information for a business.
get
Finds owner logins which have not been migrated to Staff Identity.
get
Get aggregated location count for specified studio IDs. If date range is not specified, it defaults to today's date. If endDate is not specified, it will be set to startDate vice versa. Time part of the date range will be ignored.
get
Find and returns location information for the given location within a given studio.
get
Finds basic site info.
get
Find all MbAccountNumbers for active locations within a given studio
get
Finds and returns region info for site.
get
Finds and returns basic site info for sites that fit the search criteria.
get
Retrieve basic information for all subscribers. Max page limit is 3000
get
Retrieve business information for specified studio IDs separated by a comma. Studio IDs limit is 100.
patch
Update Studio Module type in Subscriber DB and WsMaster DB
get
Finds tab information for a site.
post
Requests a password reset/change for the user. This sends the user an email with instructions on how to change their password.
post
Gets additional user authorization information needed for Arcus APIs.
patch
Updates a particular class visit for a consumer by finding it using class instance ID
post
Create a new client profile
get
Gets a client profile at a studio
get
Gets the formula notes for a client
get
Gets the notes section from a client profile at a studio
post
Gets multiple client profile with image url at a studio
get
Get the user liability waiver status (if User has signed then check for the latest waiver is signed or not)
get
Gets all the available sessions for a client at a studio
get
Gets a list of users who has subscribed for flex membership matching the provided search keyword query. Find by FirstName, LastName, Email, or ID
get
Get the notification preferences for an existing consumer
post
Create or update notification preferences for an existing consumer
get
The way to find all staff or a single staff member.
put
Replaces the staff member with the given resource.
post
Adds the staff member.
post
Do ClockIn for current staff.
get
Gets current staff clockin/out information for Arcus APIs.
post
Do ClockOut for Current Staff.
get
Gets current staff permission information needed for Arcus APIs.
get
Gets Visitor status for current user login if user is visitor type staff or not
post
Gets user information by id or email.
put
Updates a user's class visit.
post
Callback registered with the live_stream API to ensure that a user is eligible to view the video on demand content
get
Gets a list of all the forms associated with the provided form identifiers.
post
Delete Completed client form based on the formID
get
Fetch count of pending/completed forms for a given appointment by client.
get
Fetch count of forms (Pending/Completed) for all clients in a given class instance.
get
Fetch list of forms for a given appointment. Results are sorted by form state (pending first, completed last), reverse chronological order (most recent first).
get
Fetch list of forms for all clients in a given class instance. Results are sorted by form state (pending first, completed last), reverse chronological order (most recent first).
get
Fetch list of all forms for a given consumer By default, results are sorted by form state (pending first, completed last), reverse chronological order (most recent first). Response is paginated.
post
Mark delete client form based on the formId Regenerate client form in pending state
post
Request to resend a form to a consumer
Rest
Gets Visitor status for current user login if user is visitor type staff or not
get
/Users/Staff/VisitorStatus
Headers
SiteId
integer
required
Site ID
Response
OK