Mindbody Class API is one of 13 APIs that Mindbody publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Class. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, code examples, and authentication docs.
This API exposes
16 operations
across 16 paths,
and defines 70 schemas.
It is described by OpenAPI 3.2.0, at version 6.0.
Requests are made against a single base URL, https://api.mindbodyonline.com.
The identity and technical contract details declared by the specification.
Unavailability
object
Implementation of the 'Unavailability' model.
4 properties
UpdateClassScheduleNotesRequest
object
Implementation of the 'UpdateClassScheduleNotesRequest' model. A model for requesting the updates of notes of a class schedule.
1 property
RemoveClientFromClassResponse
object
Implementation of the 'RemoveClientFromClassResponse' model.
1 property
ClientRelationship
object
Implementation of the 'ClientRelationship' model. A relation between two clients.
5 properties
AddClientToClassVisit
object
Implementation of the 'AddClientToClassVisit' model.
23 properties
SubstituteClassTeacherResponse
object
Implementation of the 'SubstituteClassTeacherResponse' model.
1 property
ApiError
object
Implementation of the 'ApiError' model.
2 properties
AppointmentGenderPreference1Enum
string
AppointmentGenderPreference1Enum enumeration.
AppointmentStatusEnum
string
AppointmentStatusEnum enumeration.
ClientService
object
Implementation of the 'ClientService' model. A service that is on a client's account.
14 properties
SubstituteTeacherClass
object
Implementation of the 'SubstituteTeacherClass' model. Represents a single class instance. Used in SubstituteClassTeacher endpoint.
21 properties
WaitlistEntry
object
Implementation of the 'WaitlistEntry' model.
9 properties
ClientCreditCard
object
Implementation of the 'ClientCreditCard' model. A client credit card.
10 properties
GetClassVisitsResponse
object
Implementation of the 'GetClassVisitsResponse' model.
1 property
AddClientToClassResponse
object
Implementation of the 'AddClientToClassResponse' model.
1 property
RemoveClientsFromClassesRequest
object
Implementation of the 'RemoveClientsFromClassesRequest' model. Remove Clients From Classes Request
6 properties
ScheduleTypeEnum
string
ScheduleTypeEnum enumeration.
CustomClientFieldValue
object
Implementation of the 'CustomClientFieldValue' model. The value of a custom client field
4 properties
Staff
object
Implementation of the 'Staff' model. The Staff
38 properties
Availability
object
Implementation of the 'Availability' model. A staff availability entry
13 properties
AddOnSmall
object
Implementation of the 'AddOnSmall' model.
4 properties
Program
object
Implementation of the 'Program' model.
6 properties
ProspectStage
object
Implementation of the 'ProspectStage' model.
3 properties
AppointmentStaff
object
Implementation of the 'AppointmentStaff' model.
4 properties
GetWaitlistEntriesResponse
object
Implementation of the 'GetWaitlistEntriesResponse' model.
2 properties
Location
object
Implementation of the 'Location' model.
25 properties
SalesRep
object
Implementation of the 'SalesRep' model.
5 properties
SessionType
object
Implementation of the 'SessionType' model. SessionType contains information about the session types in a business.
13 properties
ClassSchedule
object
Implementation of the 'ClassSchedule' model. Represents a single class instance. The class meets at the start time, goes until the end time.
24 properties
TypeEnum
string
TypeEnum enumeration.
GetSemestersResponse
object
Implementation of the 'GetSemestersResponse' model. Get Semesters Response Model
2 properties
SubstituteClassTeacherRequest
object
Implementation of the 'SubstituteClassTeacherRequest' model.
6 properties
FrequencyTypeEnum
string
FrequencyTypeEnum enumeration.
GetClassDescriptionsResponse
object
Implementation of the 'GetClassDescriptionsResponse' model.
2 properties
Appointment
object
Implementation of the 'Appointment' model. Contains information about an appointment.
23 properties
GenderPreferenceEnum
string
GenderPreferenceEnum enumeration.
GetClassesResponse
object
Implementation of the 'GetClassesResponse' model.
2 properties
Class
object
Implementation of the 'Class' model. Represents a single class instance. The class meets at the start time, goes until the end time.
30 properties
Level
object
Implementation of the 'Level' model. A session level.
3 properties
Visit
object
Implementation of the 'Visit' model. Represents a specific visit to a class
28 properties
Amenity
object
Implementation of the 'Amenity' model. Definition of a location amenity
2 properties
Client
object
Implementation of the 'Client' model. The Client.
58 properties
PaginationResponse
object
Implementation of the 'PaginationResponse' model. Contains information about the pagination to use.
4 properties
RemoveClientFromClassRequest
object
Implementation of the 'RemoveClientFromClassRequest' model.
7 properties
AssignedClientIndex
object
Implementation of the 'AssignedClientIndex' model. Represents a client index value assigned to a client
2 properties
AppointmentGenderPreferenceEnum
string
AppointmentGenderPreferenceEnum enumeration.
AddClientToClassRequest
object
Implementation of the 'AddClientToClassRequest' model.
11 properties
WrittenClassSchedulesInfo
object
Implementation of the 'WrittenClassSchedulesInfo' model.
2 properties
GetClassSchedulesResponse
object
Implementation of the 'GetClassSchedulesResponse' model.
2 properties
Relationship
object
Implementation of the 'Relationship' model. Jim is a RelationshipName1 of John. John is a RelationshipName2 of Jim.
3 properties
Semester
object
Implementation of the 'Semester' model. Semesters help you quickly classify enrollments.
8 properties
Action1Enum
string
Action1Enum enumeration.
ClassDescription
object
Implementation of the 'ClassDescription' model. Represents a class definition. The class meets at the start time, goes until the end time.
15 properties
StatusEnum
string
StatusEnum enumeration.
BookingStatusEnum
string
BookingStatusEnum enumeration.
StaffSetting
object
Implementation of the 'StaffSetting' model. contains the information about the staff settings.
2 properties
UpdateClassEnrollmentScheduleRequest
object
Implementation of the 'UpdateClassEnrollmentScheduleRequest' model.
24 properties
ResourceAvailability
object
Implementation of the 'ResourceAvailability' model. An availability of a resource
3 properties
Course
object
Implementation of the 'Course' model. A course.
10 properties
CancelSingleClassRequest
object
Implementation of the 'CancelSingleClassRequest' model.
4 properties
ClassClientDetail
object
Implementation of the 'ClassClientDetail' model. Class Client Detail Object
2 properties
BookingWindow
object
Implementation of the 'BookingWindow' model. The booking window for registration
4 properties
ResourceSlim
object
Implementation of the 'ResourceSlim' model. Contains information about resources, such as rooms.
2 properties
PricingRelationships
object
Implementation of the 'PricingRelationships' model.
2 properties
CancelSingleClassResponse
object
Implementation of the 'CancelSingleClassResponse' model.
1 property
GetCoursesReponse
object
Implementation of the 'GetCoursesReponse' model. This is the response class for the get courses API
2 properties
RemoveClientsFromClassesResponse
object
Implementation of the 'RemoveClientsFromClassesResponse' model. Remove Clients From Classes Response
3 properties
Liability
object
Implementation of the 'Liability' model.
3 properties
ClientType
object
Implementation of the 'ClientType' model. Represents a client's type classification.
2 properties
AddClassEnrollmentScheduleRequest
object
Implementation of the 'AddClassEnrollmentScheduleRequest' model.
24 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mindbody publishes across the network.