Mindbody Appointment API is one of 13 APIs that Mindbody publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Appointment. 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
17 operations
across 16 paths,
and defines 65 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
Availability1
object
Implementation of the 'Availability1' model. The availability of a specific staff
13 properties
Resource
object
Implementation of the 'Resource' model.
2 properties
Appointment1
object
Implementation of the 'Appointment1' model. An appointment
22 properties
SessionType1
object
Implementation of the 'SessionType1' model.
14 properties
PublicDisplayEnum
string
PublicDisplayEnum enumeration.
AddAvailabilitiesResponse
object
Implementation of the 'AddAvailabilitiesResponse' model. Add Availabilities Response Model
2 properties
AppointmentOption
object
Implementation of the 'AppointmentOption' model. An appointment option name/value pair
4 properties
ApiError
object
Implementation of the 'ApiError' model.
2 properties
UpdateAppointmentRequest
object
Implementation of the 'UpdateAppointmentRequest' model.
14 properties
UpdateAvailabilityResponse
object
Implementation of the 'UpdateAvailabilityResponse' model. This is the update avaialability response
2 properties
GetBookableItemsResponse
object
Implementation of the 'GetBookableItemsResponse' model.
2 properties
ServiceTag
object
Implementation of the 'ServiceTag' model. ServiceTag refers to Category and Subcategory fields for classes and appointments
2 properties
GetStaffAppointmentsResponse
object
Implementation of the 'GetStaffAppointmentsResponse' model. Get Staff Appointments Response Model
2 properties
DaysOfWeekEnum
string
DaysOfWeekEnum enumeration.
Unavailability1
object
Implementation of the 'Unavailability1' model.
4 properties
Type1Enum
string
Type1Enum enumeration.
ScheduleTypeEnum
string
ScheduleTypeEnum enumeration.
ScheduleType2Enum
string
ScheduleType2Enum enumeration.
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
GetAddOnsResponse
object
Implementation of the 'GetAddOnsResponse' model. Get AddOns Response Model
2 properties
AppointmentAddOn
object
Implementation of the 'AppointmentAddOn' model.
5 properties
AddAvailabilitiesRequest
object
Implementation of the 'AddAvailabilitiesRequest' model.
10 properties
Program
object
Implementation of the 'Program' model.
6 properties
PublicDisplay1Enum
string
PublicDisplay1Enum enumeration.
AppointmentStaff
object
Implementation of the 'AppointmentStaff' model.
4 properties
Location
object
Implementation of the 'Location' model.
25 properties
SessionType
object
Implementation of the 'SessionType' model. SessionType contains information about the session types in a business.
13 properties
TypeEnum
string
TypeEnum enumeration.
ContentFormatEnum
string
ContentFormatEnum enumeration.
AddAppointmentRequest
object
Implementation of the 'AddAppointmentRequest' model. Represents a request to add a new appointment, including details such as client information, appointment t…
19 properties
Staff1
object
Implementation of the 'Staff1' model.
45 properties
ActionEnum
string
ActionEnum enumeration.
GetAvailableDatesResponse
object
Implementation of the 'GetAvailableDatesResponse' model.
1 property
AddOnSmall1
object
Implementation of the 'AddOnSmall1' model.
4 properties
Appointment
object
Implementation of the 'Appointment' model. Contains information about an appointment.
23 properties
GenderPreferenceEnum
string
GenderPreferenceEnum enumeration.
AddMultipleAppointmentsRequest
object
Implementation of the 'AddMultipleAppointmentsRequest' model. Request to add multiple appointments.
1 property
UnavailabilityPlain
object
Implementation of the 'UnavailabilityPlain' model.
5 properties
PaginationResponse
object
Implementation of the 'PaginationResponse' model. Contains information about the pagination to use.
4 properties
Amenity
object
Implementation of the 'Amenity' model. Definition of a location amenity
2 properties
ResourceAvailability1
object
Implementation of the 'ResourceAvailability1' model. An availability of a resource
5 properties
AddAppointmentOutcome
object
Implementation of the 'AddAppointmentOutcome' model. Contains information about an appointment creation outcome.
3 properties
ApiError1
object
Implementation of the 'ApiError1' model.
2 properties
GetScheduleItemsResponse
object
Implementation of the 'GetScheduleItemsResponse' model.
2 properties
AddAppointmentAddOnRequest
object
Implementation of the 'AddAppointmentAddOnRequest' model. Creates an add-on for an appointment
5 properties
UpdateAppointmentResponse
object
Implementation of the 'UpdateAppointmentResponse' model.
1 property
StatusEnum
string
StatusEnum enumeration.
GetAppointmentOptionsResponse
object
Implementation of the 'GetAppointmentOptionsResponse' model.
1 property
StaffSetting
object
Implementation of the 'StaffSetting' model. contains the information about the staff settings.
2 properties
ResourceAvailability
object
Implementation of the 'ResourceAvailability' model. An availability of a resource
3 properties
Status1Enum
string
Status1Enum enumeration.
Location1
object
Implementation of the 'Location1' model.
56 properties
Amenity1
object
Implementation of the 'Amenity1' model. A specific amenity at a location
2 properties
Program1
object
Implementation of the 'Program1' model.
9 properties
AddMultipleAppointmentsResponse
object
Implementation of the 'AddMultipleAppointmentsResponse' model. Represents the response for adding multiple appointments.
1 property
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
UpdateAvailabilityRequest
object
Implementation of the 'UpdateAvailabilityRequest' model. This is the update avaialability request coming DTO
9 properties
AddAppointmentResponse
object
Implementation of the 'AddAppointmentResponse' model.
1 property
GetUnavailabilitiesResponse
object
Implementation of the 'GetUnavailabilitiesResponse' model.
2 properties
AddAppointmentAddOnResponse
object
Implementation of the 'AddAppointmentAddOnResponse' model.
2 properties
GetActiveSessionTimesResponse
object
Implementation of the 'GetActiveSessionTimesResponse' model.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mindbody publishes across the network.