/

MImindbodyonline

Docs
History
Schema
Generate

Filter operations

Rest143

post/AutoPay/region/{regionId}/covid19/close/enddate/{endDate}Used to help close open ended supensions on autopays for a region
post/AutoPay/region/{regionId}/covid19/Suspend/startdate/{startDate}Used to help create open ended supensions on autopays for a region
post/AutoPay/subscriber/{subscriberId}/covid19/close/enddate/{endDate}Used to help close open ended supensions on autopays for a subscriber
post/AutoPay/subscriber/{subscriberId}/covid19/Suspend/startdate/{startDate}Used to help create open ended supensions on autopays for a subscriber
get/Business/Calendars/Staff/{staffId}Gets calendar events for a given staff. Staff members can only retrieve their own calendar events. Endpoint also supports Service Identity.
get/Business/CategoriesRetrieve Category by verical ids
get/Business/ClosuresRetrieves a business's closures for a given start and end date
get/Business/FeaturesGet all features for the studio
patch/Business/Features/{featureDescriptor}Patch a Feature resource
get/Business/PromoCodesRetrieve a list of promo codes
post/Business/PromoCodesCreate a new promo code
put/Business/PromoCodes/{id}Update an existing promo code
get/Business/Sales/{saleId}/EventDetailsGet calendar event details for a sale.
get/Business/Sales/SalesDetailsRetrieve a list of sales details records
post/Business/Sales/User/ServicePaymentOptions/ApplyRequest takes a list of appointment Ids. Checks if the appointment and current series exist, and then apply payment.
get/Business/Schedules/AppointmentRequests/{id}Returns the Appointment Request identified by the ID.
post/Business/Schedules/AppointmentRequests/ApproveApproves 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/Business/Schedules/AppointmentRequests/DenyDeny a single or multiple appointment requests and sends the appointment request denial email. Takes a list of appointment request Ids.
post/Business/Schedules/AppointmentRequests/deny-multipleDeny multiple appointment requests in a single operation with optional consumer notification control. This endpoint processes appointment requests and provides detailed error reporting.
get/Business/Schedules/AppointmentsGets appointment details. Takes a list of appointment ids and returns dictionary of appointment and its related objects.
post/Business/Schedules/Appointments/Addons/AddAdds Addons.
get/Business/Schedules/Appointments/Addons/AddonsGets 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/Business/Schedules/Appointments/Addons/CompleteUpdates the appointment status to completed
post/Business/Schedules/Appointments/Addons/DeleteDelete Addons
get/Business/Schedules/Appointments/Addons/GetAddonsGets 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/Business/Schedules/Appointments/Addons/ModifyModifies multiple appointments. Takes a list of appointment objects and sendEmail returns success or errors.
post/Business/Schedules/Appointments/CompleteUpdates the appointment status to completed
post/Business/Schedules/Appointments/ModifyModifies multiple appointments. Takes a list of appointment objects and sendEmail returns success or errors.
post/Business/Schedules/Appointments/RecurringBooks a recurring appointment group based on the options and returns list of AppointmentIds
post/Business/Schedules/Appointments/Recurring/ValidateValidates recurring appointment options and returns list of conflicts that might happen based on the options
get/Business/Schedules/AvailabilityGets availability schedule details. Takes a list of availability ids and returns availability schedule objects.
post/Business/Schedules/Availability/AddTakes 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/Business/Schedules/Availability/GroupTakes a list of AvailabilitySchedules and updates availabilityscheduleGroup. Returns a list of AvailabilitySchedules with GroupId
post/Business/Schedules/Availability/SearchSearches for availability schedule details for specific staff.
get/Business/Schedules/ClassesGets class instance details for the given instance.
get/Business/Schedules/Classes/{classInstanceId}Gets class instance details for the given instance.
get/Business/Schedules/Classes/{classInstanceId}/LocationGets class instance details for the given instance.
get/Business/Schedules/Classes/UpcomingGets upcoming classes for the subscriber
get/Business/Schedules/EnrollmentsGets enrollment details for a subscriber.
post/Business/Scheduling/Appointments/BookingTemplatesGets 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/Business/SubcategoriesRetrieve Category by category ids
get/Clients/DirectoryGet a list of clients with services on date provided.
get/Consumer/Sales/User/Location/{LocationId}/ServicePaymentOptionsReturns 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/Consumer/Schedules/Appointments/AppointmentTypesGets 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/Consumer/Schedules/Appointments/AppointmentTypes/{id}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/Consumer/Schedules/Appointments/LocationsThis action returns a list of locations that can schedule appointments.
post/Consumer/Schedules/Location/{locationId}/AppointmentsBooks 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/Consumer/Schedules/Location/{locationId}/Appointments/StaffBookableTimeRangesList 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/Consumer/Schedules/Location/{locationId}/Appointments-AddonsBooks single or multiple appointments with add-ons.
get/Consumer/Users/Location/{locationId}/Staff/StaffAvailableAppointmentTypesGets appointment types for a specific staff at a specific location
get/Consumer/Users/Staff/StaffAvailableAppointmentTypesGets appointment types for a specific staff.
get/Dashboard/ByCategory/GetTotalSalesGets the sales data by category for the specified month
get/Dashboard/SummaryGet's the summary data for the given criteria
get/Dashboard/YoY/GetMonthlyActiveMembersGets the monthly active member data between the specified dates
get/Dashboard/YoY/GetMonthlyAttendanceGet the monthly attendance data between the specified dates
get/Dashboard/YoY/GetMonthlyOnlineBookingsGets the monthly online booking data between the specified dates
get/Dashboard/YoY/GetMonthlySalesGets the monthly sales data between the specified dates
get/DEIB/{subscriberId}/AmenitiesRetrieve a list of all amenities that can be applied to a location.
get/DEIB/{subscriberId}/BusinessIdentifiesAsRetrieve a list of all BusinessIdentifiesAs that can be applied to a location.
get/DEIB/{subscriberId}/CrowdSafeAsRetrieve a list of all CrowdSafeAs that can be applied to a location.
get/DEIB/{subscriberId}/Location/{locationId}/AmenitiesRetrieve a list of all amenities assigned to the location indicated.
put/DEIB/{subscriberId}/Location/{locationId}/AmenitiesUpdates the amenities list assigned to a specific location to the amenities specified in the body.
get/DEIB/{subscriberId}/Location/{locationId}/BusinessIdentifiesAsRetrieve a list of all BusinessIdentifiesAs assigned to the location indicated.
put/DEIB/{subscriberId}/Location/{locationId}/BusinessIdentifiesAsUpdates the BusinessIdentifiesAs list assigned to a specific location to the BusinessIdentifiesAs specified in the body.
get/DEIB/{subscriberId}/Location/{locationId}/CrowdSafeAsRetrieve a list of all CrowdSafeAs assigned to the location indicated.
put/DEIB/{subscriberId}/Location/{locationId}/CrowdSafeAsUpdates the CrowdSafeAs list assigned to a specific location to the CrowdSafeAs specified in the body.
get/DEIB/AmenitiesRetrieve a list of all amenities that can be applied to a location.
get/DEIB/BusinessIdentifiesAsRetrieve a list of all BusinessIdentifiesAs that can be applied to a location.
get/DEIB/CrowdSafeAsRetrieve a list of all CrowdSafeAs that can be applied to a location.
get/Documents/{id}/SignatureFind the signature image url for a specified sale.
post/Documents/LiabilityReleaseUploads 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/FeedbackEndpoint used to process feedback requests.
post/live_stream/eligibilityCallback registered with the live_stream API to ensure that a user is eligible join a live stream session
post/live_stream_webhooks/status_changedCallback registered with the live_stream API to ensure that a user is eligible join a live stream session
get/MobileAppVersionsGets a list of mobile application versions. Can return version information specifically for a given product and platform. Authorization Header not required but preferred
get/NetworkMetricsFetches network metric metadata filtered based on the provided request.
get/PrivacyPreferences/PrivacyPreferencesUrlThis 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/Products/InventoryGet inventory items
get/Products/ScheduledProducts/ServicesFinds and returns all of the Services for the current subscriber.
post/Reviews/Classes/ReportEndpoint used to report MB class review abuse.
get/SettingsGets settings from General Setup and Options page.
get/Settings/AppointmentOptionsGets AppointmentOptions for a Subscriber
get/Settings/AutoEmailRetrieves a subscriber's Auto Email Settings
get/Settings/Clients/GenderOptionsGets custom gender options for a specific subscriber.
get/Settings/CountriesGets list of all available countries.
get/Settings/Countries/TerritoriesGets a list of countries with the associated territories (states or provinces).
get/Settings/LiabilityReleaseRetrieves a subscriber's Liability Release Waiver
put/Settings/LiabilityReleaseReplaces a subscriber's Liability Release Waiver with the given resource.
post/Settings/LiabilityReleaseAdds a subscriber's Liability Release Waiver
get/Settings/TaxTables/{id}List of tax tables. Every location may have up to a maximum of 5 taxes. Tax values are represented as decimals.
put/Settings/TaxTables/{id}Replaces tax tables with the given resource. Each location may have up to a maximum of 5 taxes.
get/SmokeTest/PingThe ping endpoint for the application
get/SmokeTest/ReadyEndpoint for readiness probe to check mandatory services are available
get/SmokeTest/StatusCheck status
put/SmtpSettingsUpdates the SMTP settings for the subscriber
post/SmtpSettings/TestSends a test email to the provided address with the given custom settings
get/Subscribers/BusinessinformationFinds business information for a business.
put/Subscribers/BusinessinformationReplaces the business information for a business with the given resource.
get/Subscribers/Businessinformation/OwnerFinds Owner information for a business.
get/Subscribers/Businessinformation/UnmigratedOwnersFinds owner logins which have not been migrated to Staff Identity.
get/Subscribers/LocationCountsGet 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/Subscribers/Locations/{locationId}Find and returns location information for the given location within a given studio.
get/Subscribers/SiteInformationFinds basic site info.
get/Subscribers/SiteInformation/MbAccountNumbersFind all MbAccountNumbers for active locations within a given studio
get/Subscribers/SiteInformation/RegionFinds and returns region info for site.
get/Subscribers/SiteInformation/SearchFinds and returns basic site info for sites that fit the search criteria.
get/Subscribers/StudiosRetrieve basic information for all subscribers. Max page limit is 3000
get/Subscribers/Studios/BusinessInformationRetrieve business information for specified studio IDs separated by a comma. Studio IDs limit is 100.
patch/Subscribers/Studios/UpdateStudioModuleTypeUpdate Studio Module type in Subscriber DB and WsMaster DB
get/Subscribers/TabsFinds tab information for a site.
post/Users/{id}/RequestPasswordChangeRequests a password reset/change for the user. This sends the user an email with instructions on how to change their password.
post/Users/AuthorizationInformationGets additional user authorization information needed for Arcus APIs.
patch/Users/Classes/{classInstanceId}/VisitUpdates a particular class visit for a consumer by finding it using class instance ID
post/users/clientCreate a new client profile
get/users/client/{clientId}Gets a client profile at a studio
get/users/client/{clientId}/FormulaNotesGets the formula notes for a client
get/users/client/{clientId}/notesGets the notes section from a client profile at a studio
post/users/client/ClientsProfileGets multiple client profile with image url at a studio
get/users/client/LiabilityReleaseStatusGet the user liability waiver status (if User has signed then check for the latest waiver is signed or not)
get/Users/ClientSeriesGets all the available sessions for a client at a studio
get/Users/Get/FlexMembershipUsersGets a list of users who has subscribed for flex membership matching the provided search keyword query. Find by FirstName, LastName, Email, or ID
get/Users/NotificationPreferencesGet the notification preferences for an existing consumer
post/Users/NotificationPreferencesCreate or update notification preferences for an existing consumer
get/Users/StaffThe way to find all staff or a single staff member.
put/Users/StaffReplaces the staff member with the given resource.
post/Users/StaffAdds the staff member.
post/Users/Staff/ClockInDo ClockIn for current staff.
get/Users/Staff/ClockInOutWidgetInformationGets current staff clockin/out information for Arcus APIs.
post/Users/Staff/ClockOutDo ClockOut for Current Staff.
get/Users/Staff/PermissionInformationGets current staff permission information needed for Arcus APIs.
get/Users/Staff/VisitorStatusGets Visitor status for current user login if user is visitor type staff or not
post/Users/UserInfoGets user information by id or email.
put/Users/Visits/{id}/ClassesUpdates a user's class visit.
post/video_on_demand/eligibilityCallback registered with the live_stream API to ensure that a user is eligible to view the video on demand content
get/WaiverForm/AccessLogGets a list of all the forms associated with the provided form identifiers.
post/WaiverForm/DeleteDelete Completed client form based on the formID
get/WaiverForm/FormsCountByAppointmentFetch count of pending/completed forms for a given appointment by client.
get/WaiverForm/FormsCountByClassInstanceFetch count of forms (Pending/Completed) for all clients in a given class instance.
get/WaiverForm/GetFormsByAppointmentIdFetch list of forms for a given appointment. Results are sorted by form state (pending first, completed last), reverse chronological order (most recent first).
get/WaiverForm/GetFormsByClassInstanceIdFetch 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/WaiverForm/GetFormsWithPaginationFetch 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/WaiverForm/RegenerateMark delete client form based on the formId Regenerate client form in pending state
post/WaiverForm/ResendBookingConfirmationEmailRequest to resend a form to a consumer

Rest

Changes to Gets user information by id or email.

post/Users/UserInfo

Aug 10, 2026dc2736850e42 Revision changes
- info
  endpoint added