Mindbody Sale API is one of 13 APIs that Mindbody publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sale. 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 25 operations across 23 paths, and defines 102 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.
25 operations
23 paths
102 schemas
13 GET9 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Mindbody Sale API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as API-Key (ApiKeyAuth).
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 5 scopes.
By default, every request must be authenticated.
ApiKeyAuth— Mindbody-issued API key (server-to-server). Required on every request.OAuth2— OpenID Connect bearer token issued by Mindbody Identity Service (signin.mindbodyonline.com). Required for endpoints that act on behalf of a staff or client use…
Paths & Operations 25
Across 23 paths, the API surfaces 25 operations — 13 GET, 9 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Sale 25
Sale operations.
GET
/public/v6/sale/acceptedcardtypes
Mindbody Gets a List of Card Types That the Site Accepts. You Can Also Use GET
GET
/public/v6/sale/alternativepaymentmethods
Mindbody Get Alternative and Local Payment Methods That Are Allowed for a Site
GET
/public/v6/sale/contracts
Mindbody Returns the Contracts and Autopay Options That Are Available on a
GET
/public/v6/sale/custompaymentmethods
Mindbody Get Payment Methods That Can Be Used to Pay for Sales at a Site
GET
/public/v6/sale/giftcardbalance
Mindbody Returns a Gift Card’s Remaining Balance
GET
/public/v6/sale/giftcards
Mindbody Returns Information About Gift Cards That Can Be Purchased
GET
/public/v6/sale/packages
Mindbody A Package is Typically Used to Combine Multiple Services And/or
GET
/public/v6/sale/products
Mindbody Get Retail Products Available for Purchase at a Site
PUT
/public/v6/sale/products
Mindbody Update Retail Products Available for Purchase at a Site
GET
/public/v6/sale/productsinventory
Mindbody Get Retail Products Inventory Data Available at a Site
GET
/public/v6/sale/purchasecontractstatus
Mindbody Fetches the Status of an Initiate Purchase Contract Given AccessToken
GET
/public/v6/sale/sales
Mindbody Get Sales Completed at a Site
GET
/public/v6/sale/services
Mindbody Get Pricing Options Available for Purchase at a Site
PUT
/public/v6/sale/services
Mindbody Update Unit Price and Online Price of Provided Services
GET
/public/v6/sale/transactions
Mindbody This Endpoint Returns a List of Transaction Details of Processed Sales
POST
/public/v6/sale/checkoutshoppingcart
Mindbody This Endpoint Provides a Wide Range of Functionality. for Example, You
POST
/public/v6/sale/completecheckoutshoppingcart
Mindbody This Endpoint Complements the InitiateCheckoutShoppintCart Endpoint
POST
/public/v6/sale/initiatecheckoutshoppingcart
Mindbody This Endpoint Provides a Wide Range of Functionality. for Example, You
POST
/public/v6/sale/initiatepurchasecontract
Mindbody Allows a Client to Sign Up for a Contract or Autopay Using the
POST
/public/v6/sale/purchaseaccountcredit
Mindbody Allows a Client to Purchase Account Credit from a Business
POST
/public/v6/sale/purchasecontract
Mindbody Allows a Client to Sign Up for a Contract or Autopay Using the
POST
/public/v6/sale/purchasegiftcard
Mindbody Allows a Client to Purchase a Gift Card from a Business in a Variety
POST
/public/v6/sale/returnsale
Mindbody Return a Comped Sale for a Specified Sale ID in Business Mode. the
POST
/public/v6/sale/updateproductprice
Mindbody This Endpoint Updates the Retail Price and an Online Price for a
PUT
/public/v6/sale/updatesaledate
Mindbody This Endpoint Updates the SaleDate and Returns the Details of the Sale
Schemas 102
The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are Client (58 properties), Staff (38 properties), Contract (38 properties), Class (30 properties). Each schema is shown below with its type and property counts.
GetPackagesResponse
object
Implementation of the 'GetPackagesResponse' model.
2 properties
UpdateProductPriceResponse
object
Implementation of the 'UpdateProductPriceResponse' model. Update Product Price Response Model
1 property
GetCustomPaymentMethodsResponse
object
Implementation of the 'GetCustomPaymentMethodsResponse' model.
2 properties
PurchaseGiftCardRequest
object
Implementation of the 'PurchaseGiftCardRequest' model.
17 properties
ShoppingCart
object
Implementation of the 'ShoppingCart' model. Represents a shopping cart.
8 properties
PaymentProcessingFailure
object
Implementation of the 'PaymentProcessingFailure' model. Contains information about any payment processing failure. Specifically for when an SCA challenge is
3 properties
AddOnSmall
object
Implementation of the 'AddOnSmall' model.
4 properties
Program
object
Implementation of the 'Program' model.
6 properties
SessionType
object
Implementation of the 'SessionType' model. SessionType contains information about the session types in a business.
13 properties
GetServicesResponse
object
Implementation of the 'GetServicesResponse' model.
2 properties
PurchaseAccountCreditRequest
object
Implementation of the 'PurchaseAccountCreditRequest' model.
8 properties
GiftCardLayout
object
Implementation of the 'GiftCardLayout' model. Gift card layout
3 properties
ReturnSaleRequest
object
Implementation of the 'ReturnSaleRequest' model. ReturnSaleRequest
2 properties
Package
object
Implementation of the 'Package' model.
6 properties
PurchaseContractResponseTotals
object
Implementation of the 'PurchaseContractResponseTotals' model. Totals for the purchase
4 properties
Amenity
object
Implementation of the 'Amenity' model. Definition of a location amenity
2 properties
StaffSetting
object
Implementation of the 'StaffSetting' model. contains the information about the staff settings.
2 properties
BookingWindow
object
Implementation of the 'BookingWindow' model. The booking window for registration
4 properties
CheckoutItemWrapper
object
Implementation of the 'CheckoutItemWrapper' model.
11 properties
ResourceSlim
object
Implementation of the 'ResourceSlim' model. Contains information about resources, such as rooms.
2 properties
Unavailability
object
Implementation of the 'Unavailability' model.
4 properties
PurchasedItem
object
Implementation of the 'PurchasedItem' model.
25 properties
ContractItem
object
Implementation of the 'ContractItem' model.
7 properties
MembershipTypeRestriction
object
Implementation of the 'MembershipTypeRestriction' model.
2 properties
PurchaseAccountCreditResponse
object
Implementation of the 'PurchaseAccountCreditResponse' model.
5 properties
CheckoutPaymentInfo
object
Implementation of the 'CheckoutPaymentInfo' model.
2 properties
AlternativePaymentMethod
object
Implementation of the 'AlternativePaymentMethod' model. DTO object for alternative payment methods.
2 properties
Availability
object
Implementation of the 'Availability' model. A staff availability entry
13 properties
ProspectStage
object
Implementation of the 'ProspectStage' model.
3 properties
UpdateSaleDateRequest
object
Implementation of the 'UpdateSaleDateRequest' model. Update Sales Date Request Model
2 properties
FrequencyTypeEnum
string
FrequencyTypeEnum enumeration.
InitiatePurchaseContractRequest
object
Implementation of the 'InitiatePurchaseContractRequest' model. Request to initiate a purchase contract.
10 properties
ProductsInventory
object
Implementation of the 'ProductsInventory' model.
10 properties
AssignedClientIndex
object
Implementation of the 'AssignedClientIndex' model. Represents a client index value assigned to a client
2 properties
AppointmentGenderPreferenceEnum
string
AppointmentGenderPreferenceEnum enumeration.
Relationship
object
Implementation of the 'Relationship' model. Jim is a RelationshipName1 of John. John is a RelationshipName2 of Jim.
3 properties
GiftCard
object
Implementation of the 'GiftCard' model.
12 properties
BookingStatusEnum
string
BookingStatusEnum enumeration.
ResourceAvailability
object
Implementation of the 'ResourceAvailability' model. An availability of a resource
3 properties
CreditCardInfo
object
Implementation of the 'CreditCardInfo' model. Information about an individual credit card
11 properties
TransactionResponse
object
Implementation of the 'TransactionResponse' model.
2 properties
Service
object
Implementation of the 'Service' model.
27 properties
CartItem
object
Implementation of the 'CartItem' model.
8 properties
Product
object
Implementation of the 'Product' model. Represents a product.
20 properties
Contract
object
Implementation of the 'Contract' model.
38 properties
Sale
object
Implementation of the 'Sale' model. Contains the Sale details.
11 properties
GetProductsInventoryResponse
object
Implementation of the 'GetProductsInventoryResponse' model.
2 properties
SalePayment
object
Implementation of the 'SalePayment' model.
6 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
CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest
object
Implementation of the 'CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest' model. The API Request model for Complete Checkout Shopping Cart API.
3 properties
ClientCreditCard
object
Implementation of the 'ClientCreditCard' model. A client credit card.
10 properties
GetAlternativePaymentMethodsResponse
object
Implementation of the 'GetAlternativePaymentMethodsResponse' model. Response for the GetAlternativePaymentMethods method.
1 property
GetSalesResponse
object
Implementation of the 'GetSalesResponse' model.
2 properties
Staff
object
Implementation of the 'Staff' model. The Staff
38 properties
AutopaySchedule
object
Implementation of the 'AutopaySchedule' model.
3 properties
CheckoutShoppingCartRequest
object
Implementation of the 'CheckoutShoppingCartRequest' model.
20 properties
GetProductsResponse
object
Implementation of the 'GetProductsResponse' model. Represents the response object for retrieving products.
2 properties
GetGiftCardBalanceResponse
object
Implementation of the 'GetGiftCardBalanceResponse' model.
2 properties
UpdateServiceResponse
object
Implementation of the 'UpdateServiceResponse' model. A response from the Update Services API method.
1 property
CheckoutAppointmentBookingRequest
object
Implementation of the 'CheckoutAppointmentBookingRequest' model.
7 properties
UpdateSaleDateResponse
object
Implementation of the 'UpdateSaleDateResponse' model. Update Sale Date Response Properties
1 property
Location
object
Implementation of the 'Location' model.
25 properties
SalesRep
object
Implementation of the 'SalesRep' model.
5 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.
Appointment
object
Implementation of the 'Appointment' model. Contains information about an appointment.
23 properties
Client
object
Implementation of the 'Client' model. The Client.
58 properties
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
Action1Enum
string
Action1Enum enumeration.
StoredCardInfo
object
Implementation of the 'StoredCardInfo' model.
1 property
CheckoutAlternativePaymentInfo
object
Implementation of the 'CheckoutAlternativePaymentInfo' model. Request object to capture Alternative Payment information.
2 properties
CheckoutItem
object
Implementation of the 'CheckoutItem' model.
2 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
GetGiftCardResponse
object
Implementation of the 'GetGiftCardResponse' model.
2 properties
CustomPaymentMethod
object
Implementation of the 'CustomPaymentMethod' model.
2 properties
PurchaseContractResponse
object
Implementation of the 'PurchaseContractResponse' model. Response model for POST PurchaseContract endpoint
7 properties
ClientRelationship
object
Implementation of the 'ClientRelationship' model. A relation between two clients.
5 properties
UpdateProductPriceRequest
object
Implementation of the 'UpdateProductPriceRequest' model. Update Product Price Request Model
3 properties
CheckoutShoppingCartResponse
object
Implementation of the 'CheckoutShoppingCartResponse' model. The API Response model for Checkout Shopping Cart APIs
4 properties
GetContractsResponse
object
Implementation of the 'GetContractsResponse' model.
2 properties
ReturnSaleResponse
object
Implementation of the 'ReturnSaleResponse' model. ReturnSaleResponse
3 properties
ScheduleTypeEnum
string
ScheduleTypeEnum enumeration.
CustomClientFieldValue
object
Implementation of the 'CustomClientFieldValue' model. The value of a custom client field
4 properties
GetTransactionsResponse
object
Implementation of the 'GetTransactionsResponse' model. Get transactions response properties
2 properties
Transaction
object
Implementation of the 'Transaction' model.
17 properties
AppointmentStaff
object
Implementation of the 'AppointmentStaff' model.
4 properties
PurchaseGiftCardResponse
object
Implementation of the 'PurchaseGiftCardResponse' model.
11 properties
PurchaseContractRequest
object
Implementation of the 'PurchaseContractRequest' model.
19 properties
GenderPreferenceEnum
string
GenderPreferenceEnum enumeration.
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
PaginationResponse
object
Implementation of the 'PaginationResponse' model. Contains information about the pagination to use.
4 properties
Size
object
Implementation of the 'Size' model.
2 properties
StatusEnum
string
StatusEnum enumeration.
InitiateCheckoutShoppingCartUsingAlternativePaymentsRequest
object
Implementation of the 'InitiateCheckoutShoppingCartUsingAlternativePaymentsRequest' model. The API Request model for Initiate Checkout Shopping Cart API.
15 properties
Course
object
Implementation of the 'Course' model. A course.
10 properties
PricingRelationships
object
Implementation of the 'PricingRelationships' model.
2 properties
Color
object
Implementation of the 'Color' model. A color used by products.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mindbody 12
Other APIs Mindbody publishes across the network.
Mindbody Appointment API
Mindbody Class API
Mindbody Client API
Mindbody Cross Site API
Mindbody Enrollment API
Mindbody Metrics API
Mindbody Payroll API
Mindbody Pick A Spot API
Mindbody Site API
Mindbody Staff API
Mindbody Subscriptions API
Mindbody User Token API
#Sale
Where this information came from
This is an independent, third-party profile of Mindbody Sale API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.