Mindbody website screenshot

Mindbody

Mindbody is a business management and consumer marketplace platform for the fitness, beauty, and wellness industries, providing scheduling, point of sale, client management, marketing, and reporting tools for studios, gyms, salons, and spas. The Mindbody Public API (v6) provides REST endpoints for appointments, classes, clients, enrollments, sales, sites, staff, payroll, and cross-site identity, and is paired with a Webhooks API that pushes real-time event notifications using API key + SiteId headers, with optional OAuth 2.0 bearer tokens from the Mindbody Identity Service for staff- and client-scoped operations.

2 APIs 8 Features
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

APIs

Mindbody Public API v6

REST API for Mindbody business data including appointments, classes, clients, enrollments, sales, sites, staff, payroll, pick-a-spot reservations, and cross-site identity. Authe...

Mindbody Webhooks API

Subscription and delivery platform that pushes near real-time event notifications for sites, locations, appointments, classes, clients, sales, and staff. Partners manage subscri...

Collections

Mindbody Public API v6

POSTMAN

Mindbody Webhooks API

POSTMAN

Arazzo Workflows

Mindbody Add Client and Book Class

Create a new client, find an upcoming class, and book the client into it.

ARAZZO

Mindbody Book Appointment

Find bookable appointment availabilities and book an appointment into an open slot.

ARAZZO

Mindbody Browse Services and Checkout

List sellable services, check out a cart for a client, and confirm the sale.

ARAZZO

Mindbody Checkout Cart and Confirm Sale

Check out a shopping cart for a client and confirm the resulting sale.

ARAZZO

Mindbody Client Arrival Check-In

Find a client by search text and log their arrival at a location.

ARAZZO

Mindbody Client Membership Review

Find a client and review their active memberships.

ARAZZO

Mindbody Client Visit History

Find a client and retrieve their visit history for a date range.

ARAZZO

Mindbody Enroll Client in Program

List available enrollments and add a client to a chosen enrollment.

ARAZZO

Mindbody Find Client Purchases

Find a client and retrieve their purchase history.

ARAZZO

Mindbody Issue User Token and List Clients

Issue a staff user token and use it to list clients at a site.

ARAZZO

Mindbody Log Client Contact

Find a client and add a contact log entry to their record.

ARAZZO

Mindbody Resolve Site and List Classes

Resolve the activated sites for an API key and list the classes for one site.

ARAZZO

Mindbody Schedule Items by Location

List a site's locations and retrieve the schedule items for one location.

ARAZZO

Mindbody Session Type Book Appointment

Discover session types, find a bookable slot, and book an appointment.

ARAZZO

Mindbody Staff Class Schedule

Resolve a staff member and retrieve their schedule items for a date range.

ARAZZO

Mindbody Staff Schedule Lookup

Look up a staff member and retrieve their booked appointments for a date range.

ARAZZO

GraphQL

Mindbody GraphQL Schema

This conceptual GraphQL schema represents the Mindbody Public API v6 domain model for fitness, wellness, and beauty business management. Mindbody exposes a REST API at `https://...

GRAPHQL

Pricing Plans

Mindbody Plans Pricing

4 plans

PLANS

Rate Limits

Mindbody Rate Limits

6 limits

RATE LIMITS

FinOps

Mindbody Finops

FINOPS

Features

Booking and Scheduling

Online booking widgets, class schedules, appointments, enrollments, and Pick-a-Spot reservations.

Point of Sale

In-studio POS for products, services, contracts, gift cards, custom payment methods, refunds, and returns.

Client Management

Client profiles, contracts, services, contact logs, formula notes, custom fields, and red/yellow alerts.

Staff and Payroll

Staff schedules, permissions, availability, class pay, commissions, and time-clock reporting.

Webhooks

HMAC-signed, near real-time delivery of site, location, appointment, class, client, sale, and staff events.

Identity and OAuth

OpenID Connect via signin.mindbodyonline.com with the Mindbody.Api.Public.v6 scope for delegated calls.

Cross-Site Lookup

Discover which Mindbody businesses a client is associated with across the network.

Marketplace Listing

Mindbody consumer app marketplace exposes participating studios to nearby members.

Use Cases

Studio Booking Apps

Build branded mobile or web booking experiences for yoga, pilates, barre, and fitness studios.

CRM and Marketing Automation

Sync clients and sales events into CRMs (HubSpot, Salesforce) and trigger marketing journeys.

Wellness Aggregator Integrations

Power class/appointment discovery and booking in third-party wellness apps and ClassPass-style platforms.

Studio Operations Analytics

Pipe payroll, sales, and class fill data into BI tooling for chain operators.

Customer Loyalty Programs

Drive loyalty points and rewards from visit/sale events delivered via the Webhooks API.

Network Identity

Use Cross-Site to recognize repeat clients across affiliated Mindbody businesses.

Integrations

Mindbody Identity Service

OpenID Connect provider at signin.mindbodyonline.com powering OAuth 2.0 flows for the Public API.

Mindbody Marketplace

Consumer app surface exposing participating studios for nearby discovery and booking.

Partner Store

Mindbody-vetted directory of integrations at partnerstore.mindbodyonline.com.

ClassPass

Aggregator marketplace integrating with Mindbody for class supply.

Payment Processors

Integrated card processing and custom payment methods routed through the Sale endpoints.

Solutions

Boutique Fitness

Yoga, pilates, barre, indoor cycling, HIIT, and martial-arts studios.

Beauty and Salon

Hair, nail, and beauty salons using appointment scheduling and POS.

Spa and Wellness

Day spas, medspas, and integrative wellness centers.

Health Clubs and Gyms

Multi-location gyms and health clubs with classes, personal training, and recurring memberships.

Semantic Vocabularies

Mindbody Public Api V6 Context

309 classes · 797 properties

JSON-LD

Mindbody Webhooks Api Context

13 classes · 25 properties

JSON-LD

API Governance Rules

Mindbody API Rules

44 rules · 16 errors 23 warnings 5 info

SPECTRAL

JSON Structure

Public Api V6 Action Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Action1 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Action11 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Action8 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Activation Type Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Add Appointment Add On Request Structure

5 properties

JSON STRUCTURE

Public Api V6 Add Appointment Add On Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Add Appointment Outcome Structure

3 properties

JSON STRUCTURE

Public Api V6 Add Appointment Request Structure

19 properties

JSON STRUCTURE

Public Api V6 Add Appointment Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Add Arrival Request Structure

5 properties

JSON STRUCTURE

Public Api V6 Add Arrival Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Add Availabilities Request Structure

10 properties

JSON STRUCTURE

Public Api V6 Add Availabilities Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Add Class Enrollment Schedule Request Structure

24 properties

JSON STRUCTURE

Public Api V6 Add Client Direct Debit Info Request Structure

6 properties

JSON STRUCTURE

Public Api V6 Add Client Direct Debit Info Response Structure

5 properties

JSON STRUCTURE

Public Api V6 Add Client Request Structure

60 properties

JSON STRUCTURE

Public Api V6 Add Client Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Add Client To Class Request Structure

11 properties

JSON STRUCTURE

Public Api V6 Add Client To Class Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Add Client To Class Visit Structure

23 properties

JSON STRUCTURE

Public Api V6 Add Client To Enrollment Request Structure

8 properties

JSON STRUCTURE

Public Api V6 Add Contact Log Request Structure

10 properties

JSON STRUCTURE

Public Api V6 Add Contact Log Type Structure

2 properties

JSON STRUCTURE

Public Api V6 Add Formula Note Request Structure

3 properties

JSON STRUCTURE

Public Api V6 Add Multiple Appointments Request Structure

1 properties

JSON STRUCTURE

Public Api V6 Add Multiple Appointments Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Add On Small Structure

4 properties

JSON STRUCTURE

Public Api V6 Add On Small1 Structure

4 properties

JSON STRUCTURE

Public Api V6 Add Promo Code Request Structure

11 properties

JSON STRUCTURE

Public Api V6 Add Promo Code Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Add Site Client Index Request Structure

9 properties

JSON STRUCTURE

Public Api V6 Add Site Client Index Response Structure

10 properties

JSON STRUCTURE

Public Api V6 Add Staff Availability Request Structure

11 properties

JSON STRUCTURE

Public Api V6 Add Staff Request Structure

26 properties

JSON STRUCTURE

Public Api V6 Add Staff Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Allowed Permission Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Alternative Payment Method Structure

2 properties

JSON STRUCTURE

Public Api V6 Amenity Structure

2 properties

JSON STRUCTURE

Public Api V6 Amenity1 Structure

2 properties

JSON STRUCTURE

Public Api V6 Api Error1 Structure

2 properties

JSON STRUCTURE

Public Api V6 Applicable Item Structure

3 properties

JSON STRUCTURE

Public Api V6 Appointment Add On Structure

5 properties

JSON STRUCTURE

Public Api V6 Appointment Gender Preference Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Appointment Gender Preference1 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Appointment Option Structure

4 properties

JSON STRUCTURE

Public Api V6 Appointment Staff Structure

4 properties

JSON STRUCTURE

Public Api V6 Appointment Status Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Appointment Structure

23 properties

JSON STRUCTURE

Public Api V6 Appointment1 Structure

22 properties

JSON STRUCTURE

Public Api V6 Assign Staff Session Type Request Structure

8 properties

JSON STRUCTURE

Public Api V6 Assign Staff Session Type Response Structure

8 properties

JSON STRUCTURE

Public Api V6 Assigned Client Index Structure

2 properties

JSON STRUCTURE

Public Api V6 Autopay Schedule Structure

3 properties

JSON STRUCTURE

Public Api V6 Autopay Status Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Availability Structure

13 properties

JSON STRUCTURE

Public Api V6 Availability1 Structure

13 properties

JSON STRUCTURE

Public Api V6 Booking Status Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Booking Window Structure

4 properties

JSON STRUCTURE

Public Api V6 Cancel Single Class Request Structure

4 properties

JSON STRUCTURE

Public Api V6 Cancel Single Class Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Cart Item Structure

8 properties

JSON STRUCTURE

Public Api V6 Category Structure

11 properties

JSON STRUCTURE

Public Api V6 Checkout Alternative Payment Info Structure

2 properties

JSON STRUCTURE

Public Api V6 Checkout Appointment Booking Request Structure

7 properties

JSON STRUCTURE

Public Api V6 Checkout Item Structure

2 properties

JSON STRUCTURE

Public Api V6 Checkout Item Wrapper Structure

11 properties

JSON STRUCTURE

Public Api V6 Checkout Payment Info Structure

2 properties

JSON STRUCTURE

Public Api V6 Checkout Shopping Cart Request Structure

20 properties

JSON STRUCTURE

Public Api V6 Checkout Shopping Cart Response Structure

4 properties

JSON STRUCTURE

Public Api V6 Class Client Detail Structure

2 properties

JSON STRUCTURE

Public Api V6 Class Description Structure

15 properties

JSON STRUCTURE

Public Api V6 Class Schedule Structure

24 properties

JSON STRUCTURE

Public Api V6 Class Structure

30 properties

JSON STRUCTURE

Public Api V6 Client Arrival Structure

4 properties

JSON STRUCTURE

Public Api V6 Client Contract Structure

23 properties

JSON STRUCTURE

Public Api V6 Client Credit Card Structure

10 properties

JSON STRUCTURE

Public Api V6 Client Document Structure

3 properties

JSON STRUCTURE

Public Api V6 Client Duplicate Structure

5 properties

JSON STRUCTURE

Public Api V6 Client Index Structure

6 properties

JSON STRUCTURE

Public Api V6 Client Index Value Structure

3 properties

JSON STRUCTURE

Public Api V6 Client Membership Structure

17 properties

JSON STRUCTURE

Public Api V6 Client Memberships Structure

3 properties

JSON STRUCTURE

Public Api V6 Client Purchase Record Structure

9 properties

JSON STRUCTURE

Public Api V6 Client Relationship Structure

5 properties

JSON STRUCTURE

Public Api V6 Client Reward Transaction Structure

6 properties

JSON STRUCTURE

Public Api V6 Client Service Structure

14 properties

JSON STRUCTURE

Public Api V6 Client Service With Activation Type Structure

16 properties

JSON STRUCTURE

Public Api V6 Client Structure

58 properties

JSON STRUCTURE

Public Api V6 Client Suspension Info Structure

3 properties

JSON STRUCTURE

Public Api V6 Client Type Structure

2 properties

JSON STRUCTURE

Public Api V6 Client With Suspension Info Structure

59 properties

JSON STRUCTURE

Public Api V6 Color Structure

2 properties

JSON STRUCTURE

Public Api V6 Commission Detail Structure

2 properties

JSON STRUCTURE

Public Api V6 Commission Payroll Purchase Event Structure

7 properties

JSON STRUCTURE

Public Api V6 Complete Checkout Shopping Cart Using Alternative Payments Request Structure

3 properties

JSON STRUCTURE

Public Api V6 Contact Log Comment Structure

4 properties

JSON STRUCTURE

Public Api V6 Contact Log Structure

11 properties

JSON STRUCTURE

Public Api V6 Contact Log Sub Type Structure

2 properties

JSON STRUCTURE

Public Api V6 Contact Log Type Structure

3 properties

JSON STRUCTURE

Public Api V6 Content Format Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Contract Item Structure

7 properties

JSON STRUCTURE

Public Api V6 Contract Structure

38 properties

JSON STRUCTURE

Public Api V6 Copy Credit Card Request Structure

6 properties

JSON STRUCTURE

Public Api V6 Copy Credit Card Response Client Structure

5 properties

JSON STRUCTURE

Public Api V6 Copy Credit Card Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Course Structure

10 properties

JSON STRUCTURE

Public Api V6 Create Reservation Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Credit Card Info Structure

11 properties

JSON STRUCTURE

Public Api V6 Cross Regional Client Association Structure

4 properties

JSON STRUCTURE

Public Api V6 Custom Client Field Structure

3 properties

JSON STRUCTURE

Public Api V6 Custom Client Field Value Structure

4 properties

JSON STRUCTURE

Public Api V6 Custom Payment Method Structure

2 properties

JSON STRUCTURE

Public Api V6 Days Of Week Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Days Valid Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Deactivate Promo Code Request Structure

1 properties

JSON STRUCTURE

Public Api V6 Denied Permission Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Direct Debit Info Structure

4 properties

JSON STRUCTURE

Public Api V6 Discount Structure

2 properties

JSON STRUCTURE

Public Api V6 Formula Note Response Structure

10 properties

JSON STRUCTURE

Public Api V6 Frequency Type Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Gender Option Structure

4 properties

JSON STRUCTURE

Public Api V6 Gender Preference Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Get Activation Code Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Active Client Memberships Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Active Clients Memberships Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Active Session Times Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Add Ons Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Alternative Payment Methods Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Appointment Options Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Available Dates Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Bookable Items Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Categories Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Class Descriptions Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Class Schedules Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Class Visits Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Classes Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Account Balances Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Complete Info Response Structure

5 properties

JSON STRUCTURE

Public Api V6 Get Client Contracts Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Duplicates Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Formula Notes Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Indexes Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Client Purchases Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Referral Types Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Client Rewards Response Structure

3 properties

JSON STRUCTURE

Public Api V6 Get Client Schedule Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Services Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Client Visits Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Clients Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Commissions Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Contact Log Types Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Contact Logs Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Contracts Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Courses Reponse Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Cross Regional Client Associations Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Custom Client Fields Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Custom Payment Methods Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Enrollments Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Genders Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Gift Card Balance Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Gift Card Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Liability Waiver Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Locations Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Memberships Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Mobile Providers Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Packages Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Payment Types Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Pick Aspot Class Response Structure

3 properties

JSON STRUCTURE

Public Api V6 Get Products Inventory Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Products Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Programs Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Promo Codes Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Prospect Stages Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Relationships Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Required Client Fields Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Reservation Response Structure

3 properties

JSON STRUCTURE

Public Api V6 Get Resource Availabilities Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Sales Reps Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Sales Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Schedule Items Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Scheduled Service Earnings Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Semesters Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Services Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Session Types Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Sites Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Staff Appointments Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Staff Image Urlresponse Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Staff Permissions Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Get Staff Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Staff Session Types Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Time Cards Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Tips Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Transactions Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Unavailabilities Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Get Waitlist Entries Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Gift Card Layout Structure

3 properties

JSON STRUCTURE

Public Api V6 Gift Card Structure

12 properties

JSON STRUCTURE

Public Api V6 Http Content Structure

1 properties

JSON STRUCTURE

Public Api V6 Initiate Checkout Shopping Cart Using Alternative Payments Request Structure

15 properties

JSON STRUCTURE

Public Api V6 Initiate Purchase Contract Request Structure

10 properties

JSON STRUCTURE

Public Api V6 Issue Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Issue Response Structure

4 properties

JSON STRUCTURE

Public Api V6 Lead Channel Structure

5 properties

JSON STRUCTURE

Public Api V6 Level Structure

3 properties

JSON STRUCTURE

Public Api V6 Liability Structure

3 properties

JSON STRUCTURE

Public Api V6 Location Structure

25 properties

JSON STRUCTURE

Public Api V6 Location1 Structure

56 properties

JSON STRUCTURE

Public Api V6 M0 Culture Neutral Public Key Token B77A5C561934E089 Structure

2 properties

JSON STRUCTURE

Public Api V6 Membership Structure

14 properties

JSON STRUCTURE

Public Api V6 Membership Type Restriction Structure

2 properties

JSON STRUCTURE

Public Api V6 Merge Clients Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Minimum Commitment Unit Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Mobile Provider Structure

4 properties

JSON STRUCTURE

Public Api V6 Package Structure

6 properties

JSON STRUCTURE

Public Api V6 Pagination Response Structure

4 properties

JSON STRUCTURE

Public Api V6 Pagination Structure

4 properties

JSON STRUCTURE

Public Api V6 Payment Method Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Payment Processing Failure Structure

3 properties

JSON STRUCTURE

Public Api V6 Payment Type Structure

4 properties

JSON STRUCTURE

Public Api V6 Pick Aspot Class Structure

11 properties

JSON STRUCTURE

Public Api V6 Pricing Relationships Structure

2 properties

JSON STRUCTURE

Public Api V6 Product Structure

20 properties

JSON STRUCTURE

Public Api V6 Products Inventory Structure

10 properties

JSON STRUCTURE

Public Api V6 Program Membership Structure

2 properties

JSON STRUCTURE

Public Api V6 Program Structure

6 properties

JSON STRUCTURE

Public Api V6 Program1 Structure

9 properties

JSON STRUCTURE

Public Api V6 Promo Code Structure

14 properties

JSON STRUCTURE

Public Api V6 Prospect Stage Structure

3 properties

JSON STRUCTURE

Public Api V6 Public Display Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Public Display1 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Purchase Account Credit Request Structure

8 properties

JSON STRUCTURE

Public Api V6 Purchase Account Credit Response Structure

5 properties

JSON STRUCTURE

Public Api V6 Purchase Contract Request Structure

19 properties

JSON STRUCTURE

Public Api V6 Purchase Contract Response Structure

7 properties

JSON STRUCTURE

Public Api V6 Purchase Contract Response Totals Structure

4 properties

JSON STRUCTURE

Public Api V6 Purchase Gift Card Request Structure

17 properties

JSON STRUCTURE

Public Api V6 Purchase Gift Card Response Structure

11 properties

JSON STRUCTURE

Public Api V6 Purchased Item Structure

25 properties

JSON STRUCTURE

Public Api V6 Relationship Structure

3 properties

JSON STRUCTURE

Public Api V6 Remove Client From Class Request Structure

7 properties

JSON STRUCTURE

Public Api V6 Remove Client From Class Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Remove Clients From Classes Request Structure

6 properties

JSON STRUCTURE

Public Api V6 Remove Clients From Classes Response Structure

3 properties

JSON STRUCTURE

Public Api V6 Reservation Structure

9 properties

JSON STRUCTURE

Public Api V6 Resource Availability Structure

3 properties

JSON STRUCTURE

Public Api V6 Resource Availability1 Structure

5 properties

JSON STRUCTURE

Public Api V6 Resource Slim Structure

2 properties

JSON STRUCTURE

Public Api V6 Resource Structure

2 properties

JSON STRUCTURE

Public Api V6 Response Details Structure

3 properties

JSON STRUCTURE

Public Api V6 Return Sale Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Return Sale Response Structure

3 properties

JSON STRUCTURE

Public Api V6 Sale Payment Structure

6 properties

JSON STRUCTURE

Public Api V6 Sale Structure

11 properties

JSON STRUCTURE

Public Api V6 Sales Rep Response Structure

4 properties

JSON STRUCTURE

Public Api V6 Sales Rep Structure

5 properties

JSON STRUCTURE

Public Api V6 Schedule Type Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Schedule Type2 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Scheduled Service Earnings Event Structure

5 properties

JSON STRUCTURE

Public Api V6 Scheduled Service Type Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Semester Structure

8 properties

JSON STRUCTURE

Public Api V6 Send Auto Email Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Send Password Reset Email Request Structure

3 properties

JSON STRUCTURE

Public Api V6 Service Structure

27 properties

JSON STRUCTURE

Public Api V6 Service Tag Structure

2 properties

JSON STRUCTURE

Public Api V6 Session Type Structure

13 properties

JSON STRUCTURE

Public Api V6 Session Type1 Structure

14 properties

JSON STRUCTURE

Public Api V6 Shopping Cart Structure

8 properties

JSON STRUCTURE

Public Api V6 Site Structure

23 properties

JSON STRUCTURE

Public Api V6 Size Structure

2 properties

JSON STRUCTURE

Public Api V6 Spot Structure

3 properties

JSON STRUCTURE

Public Api V6 Staff Permission Group Structure

4 properties

JSON STRUCTURE

Public Api V6 Staff Session Type Structure

15 properties

JSON STRUCTURE

Public Api V6 Staff Setting Structure

2 properties

JSON STRUCTURE

Public Api V6 Staff Structure

38 properties

JSON STRUCTURE

Public Api V6 Staff1 Structure

45 properties

JSON STRUCTURE

Public Api V6 Status Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Status1 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Stored Card Info Structure

1 properties

JSON STRUCTURE

Public Api V6 Sub Category Structure

3 properties

JSON STRUCTURE

Public Api V6 Substitute Class Teacher Request Structure

6 properties

JSON STRUCTURE

Public Api V6 Substitute Class Teacher Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Substitute Teacher Class Structure

21 properties

JSON STRUCTURE

Public Api V6 Suspend Contract Request Structure

9 properties

JSON STRUCTURE

Public Api V6 Suspend Contract Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Terminate Contract Request Structure

5 properties

JSON STRUCTURE

Public Api V6 Terminate Contract Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Time Card Event Structure

7 properties

JSON STRUCTURE

Public Api V6 Tip Structure

4 properties

JSON STRUCTURE

Public Api V6 Transaction Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Transaction Structure

17 properties

JSON STRUCTURE

Public Api V6 Type Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Type1 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Type2 Enum Structure

0 properties

JSON STRUCTURE

Public Api V6 Unavailability Plain Structure

5 properties

JSON STRUCTURE

Public Api V6 Unavailability Structure

4 properties

JSON STRUCTURE

Public Api V6 Unavailability1 Structure

4 properties

JSON STRUCTURE

Public Api V6 Upcoming Autopay Event Structure

7 properties

JSON STRUCTURE

Public Api V6 Update Appointment Request Structure

14 properties

JSON STRUCTURE

Public Api V6 Update Appointment Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Availability Request Structure

9 properties

JSON STRUCTURE

Public Api V6 Update Availability Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Update Class Enrollment Schedule Request Structure

24 properties

JSON STRUCTURE

Public Api V6 Update Class Schedule Notes Request Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Client Contract Autopays Request Structure

7 properties

JSON STRUCTURE

Public Api V6 Update Client Request Structure

5 properties

JSON STRUCTURE

Public Api V6 Update Client Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Client Rewards Request Structure

6 properties

JSON STRUCTURE

Public Api V6 Update Client Service Request Structure

5 properties

JSON STRUCTURE

Public Api V6 Update Client Service Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Client Visit Request Structure

7 properties

JSON STRUCTURE

Public Api V6 Update Client Visit Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Contact Log Comment Structure

2 properties

JSON STRUCTURE

Public Api V6 Update Contact Log Request Structure

10 properties

JSON STRUCTURE

Public Api V6 Update Contact Log Type Structure

2 properties

JSON STRUCTURE

Public Api V6 Update Product Price Request Structure

3 properties

JSON STRUCTURE

Public Api V6 Update Product Price Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Reservation Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Update Sale Date Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Update Sale Date Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Service Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Site Client Index Request Structure

10 properties

JSON STRUCTURE

Public Api V6 Update Site Client Index Response Structure

10 properties

JSON STRUCTURE

Public Api V6 Update Staff Permissions Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Update Staff Permissions Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Update Staff Request Structure

28 properties

JSON STRUCTURE

Public Api V6 Update Staff Response Structure

1 properties

JSON STRUCTURE

Public Api V6 Upload Client Document Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Upload Client Document Response Structure

2 properties

JSON STRUCTURE

Public Api V6 Upload Client Photo Request Structure

2 properties

JSON STRUCTURE

Public Api V6 Upload Client Photo Response Structure

2 properties

JSON STRUCTURE

Public Api V6 User Structure

4 properties

JSON STRUCTURE

Public Api V6 Visit Structure

28 properties

JSON STRUCTURE

Public Api V6 Visit Waitlist Info Structure

2 properties

JSON STRUCTURE

Public Api V6 Visit With Waitlist Info Structure

29 properties

JSON STRUCTURE

Public Api V6 Waitlist Entry Structure

9 properties

JSON STRUCTURE

Public Api V6 Written Class Schedules Info Structure

2 properties

JSON STRUCTURE

Webhooks Api Create Subscription Request Structure

4 properties

JSON STRUCTURE

Webhooks Api Create Subscription Response Structure

11 properties

JSON STRUCTURE

Webhooks Api Deactivate Subscription Response Structure

4 properties

JSON STRUCTURE

Webhooks Api Get Metrics Response Structure

1 properties

JSON STRUCTURE

Webhooks Api Get Subscriptions Response Structure

1 properties

JSON STRUCTURE

Webhooks Api Metric Structure

8 properties

JSON STRUCTURE

Webhooks Api Patch Subscription Request Structure

5 properties

JSON STRUCTURE

Webhooks Api Push Api Error Structure

3 properties

JSON STRUCTURE

Webhooks Api Push Api Result Create Subscription Response Structure

3 properties

JSON STRUCTURE

Webhooks Api Push Api Result Deactivate Subscription Response Structure

3 properties

JSON STRUCTURE

Webhooks Api Push Api Result Get Subscriptions Response Structure

3 properties

JSON STRUCTURE

Webhooks Api Push Api Result Subscription Structure

3 properties

JSON STRUCTURE

Webhooks Api Subscription Structure

10 properties

JSON STRUCTURE

Example Payloads

Public Api V6 Add Appointment Add On Request Example

5 fields

EXAMPLE

Public Api V6 Add Appointment Add On Response Example

2 fields

EXAMPLE

Public Api V6 Add Appointment Outcome Example

3 fields

EXAMPLE

Public Api V6 Add Appointment Request Example

19 fields

EXAMPLE

Public Api V6 Add Appointment Response Example

1 fields

EXAMPLE

Public Api V6 Add Arrival Request Example

5 fields

EXAMPLE

Public Api V6 Add Arrival Response Example

2 fields

EXAMPLE

Public Api V6 Add Availabilities Request Example

10 fields

EXAMPLE

Public Api V6 Add Availabilities Response Example

2 fields

EXAMPLE

Public Api V6 Add Class Enrollment Schedule Request Example

24 fields

EXAMPLE

Public Api V6 Add Client Direct Debit Info Request Example

6 fields

EXAMPLE

Public Api V6 Add Client Direct Debit Info Response Example

5 fields

EXAMPLE

Public Api V6 Add Client Request Example

60 fields

EXAMPLE

Public Api V6 Add Client Response Example

1 fields

EXAMPLE

Public Api V6 Add Client To Class Request Example

11 fields

EXAMPLE

Public Api V6 Add Client To Class Response Example

1 fields

EXAMPLE

Public Api V6 Add Client To Class Visit Example

23 fields

EXAMPLE

Public Api V6 Add Client To Enrollment Request Example

8 fields

EXAMPLE

Public Api V6 Add Contact Log Request Example

10 fields

EXAMPLE

Public Api V6 Add Contact Log Type Example

2 fields

EXAMPLE

Public Api V6 Add Formula Note Request Example

3 fields

EXAMPLE

Public Api V6 Add Multiple Appointments Request Example

1 fields

EXAMPLE

Public Api V6 Add Multiple Appointments Response Example

1 fields

EXAMPLE

Public Api V6 Add On Small Example

4 fields

EXAMPLE

Public Api V6 Add On Small1 Example

4 fields

EXAMPLE

Public Api V6 Add Promo Code Request Example

11 fields

EXAMPLE

Public Api V6 Add Promo Code Response Example

1 fields

EXAMPLE

Public Api V6 Add Site Client Index Request Example

9 fields

EXAMPLE

Public Api V6 Add Site Client Index Response Example

10 fields

EXAMPLE

Public Api V6 Add Staff Availability Request Example

11 fields

EXAMPLE

Public Api V6 Add Staff Request Example

26 fields

EXAMPLE

Public Api V6 Add Staff Response Example

1 fields

EXAMPLE

Public Api V6 Alternative Payment Method Example

2 fields

EXAMPLE

Public Api V6 Amenity Example

2 fields

EXAMPLE

Public Api V6 Amenity1 Example

2 fields

EXAMPLE

Public Api V6 Api Error1 Example

2 fields

EXAMPLE

Public Api V6 Applicable Item Example

3 fields

EXAMPLE

Public Api V6 Appointment Add On Example

5 fields

EXAMPLE

Public Api V6 Appointment Example

23 fields

EXAMPLE

Public Api V6 Appointment Option Example

4 fields

EXAMPLE

Public Api V6 Appointment Staff Example

4 fields

EXAMPLE

Public Api V6 Appointment1 Example

22 fields

EXAMPLE

Public Api V6 Assign Staff Session Type Request Example

8 fields

EXAMPLE

Public Api V6 Assign Staff Session Type Response Example

8 fields

EXAMPLE

Public Api V6 Assigned Client Index Example

2 fields

EXAMPLE

Public Api V6 Autopay Schedule Example

3 fields

EXAMPLE

Public Api V6 Availability Example

13 fields

EXAMPLE

Public Api V6 Availability1 Example

13 fields

EXAMPLE

Public Api V6 Booking Window Example

4 fields

EXAMPLE

Public Api V6 Cancel Single Class Request Example

4 fields

EXAMPLE

Public Api V6 Cancel Single Class Response Example

1 fields

EXAMPLE

Public Api V6 Cart Item Example

8 fields

EXAMPLE

Public Api V6 Category Example

11 fields

EXAMPLE

Public Api V6 Checkout Alternative Payment Info Example

2 fields

EXAMPLE

Public Api V6 Checkout Appointment Booking Request Example

7 fields

EXAMPLE

Public Api V6 Checkout Item Example

2 fields

EXAMPLE

Public Api V6 Checkout Item Wrapper Example

11 fields

EXAMPLE

Public Api V6 Checkout Payment Info Example

2 fields

EXAMPLE

Public Api V6 Checkout Shopping Cart Request Example

20 fields

EXAMPLE

Public Api V6 Checkout Shopping Cart Response Example

4 fields

EXAMPLE

Public Api V6 Class Client Detail Example

2 fields

EXAMPLE

Public Api V6 Class Description Example

15 fields

EXAMPLE

Public Api V6 Class Example

30 fields

EXAMPLE

Public Api V6 Class Schedule Example

24 fields

EXAMPLE

Public Api V6 Client Arrival Example

4 fields

EXAMPLE

Public Api V6 Client Contract Example

23 fields

EXAMPLE

Public Api V6 Client Credit Card Example

10 fields

EXAMPLE

Public Api V6 Client Document Example

3 fields

EXAMPLE

Public Api V6 Client Duplicate Example

5 fields

EXAMPLE

Public Api V6 Client Example

58 fields

EXAMPLE

Public Api V6 Client Index Example

6 fields

EXAMPLE

Public Api V6 Client Index Value Example

3 fields

EXAMPLE

Public Api V6 Client Membership Example

17 fields

EXAMPLE

Public Api V6 Client Memberships Example

3 fields

EXAMPLE

Public Api V6 Client Purchase Record Example

9 fields

EXAMPLE

Public Api V6 Client Relationship Example

5 fields

EXAMPLE

Public Api V6 Client Reward Transaction Example

6 fields

EXAMPLE

Public Api V6 Client Service Example

14 fields

EXAMPLE

Public Api V6 Client Service With Activation Type Example

16 fields

EXAMPLE

Public Api V6 Client Suspension Info Example

3 fields

EXAMPLE

Public Api V6 Client Type Example

2 fields

EXAMPLE

Public Api V6 Client With Suspension Info Example

59 fields

EXAMPLE

Public Api V6 Color Example

2 fields

EXAMPLE

Public Api V6 Commission Detail Example

2 fields

EXAMPLE

Public Api V6 Commission Payroll Purchase Event Example

7 fields

EXAMPLE

Public Api V6 Complete Checkout Shopping Cart Using Alternative Payments Request Example

3 fields

EXAMPLE

Public Api V6 Contact Log Comment Example

4 fields

EXAMPLE

Public Api V6 Contact Log Example

11 fields

EXAMPLE

Public Api V6 Contact Log Sub Type Example

2 fields

EXAMPLE

Public Api V6 Contact Log Type Example

3 fields

EXAMPLE

Public Api V6 Contract Example

38 fields

EXAMPLE

Public Api V6 Contract Item Example

7 fields

EXAMPLE

Public Api V6 Copy Credit Card Request Example

6 fields

EXAMPLE

Public Api V6 Copy Credit Card Response Client Example

5 fields

EXAMPLE

Public Api V6 Copy Credit Card Response Example

2 fields

EXAMPLE

Public Api V6 Course Example

10 fields

EXAMPLE

Public Api V6 Create Reservation Response Example

2 fields

EXAMPLE

Public Api V6 Credit Card Info Example

11 fields

EXAMPLE

Public Api V6 Cross Regional Client Association Example

4 fields

EXAMPLE

Public Api V6 Custom Client Field Example

3 fields

EXAMPLE

Public Api V6 Custom Client Field Value Example

4 fields

EXAMPLE

Public Api V6 Custom Payment Method Example

2 fields

EXAMPLE

Public Api V6 Deactivate Promo Code Request Example

1 fields

EXAMPLE

Public Api V6 Direct Debit Info Example

4 fields

EXAMPLE

Public Api V6 Discount Example

2 fields

EXAMPLE

Public Api V6 Formula Note Response Example

10 fields

EXAMPLE

Public Api V6 Gender Option Example

4 fields

EXAMPLE

Public Api V6 Get Activation Code Response Example

2 fields

EXAMPLE

Public Api V6 Get Active Client Memberships Response Example

2 fields

EXAMPLE

Public Api V6 Get Active Clients Memberships Response Example

2 fields

EXAMPLE

Public Api V6 Get Active Session Times Response Example

2 fields

EXAMPLE

Public Api V6 Get Add Ons Response Example

2 fields

EXAMPLE

Public Api V6 Get Alternative Payment Methods Response Example

1 fields

EXAMPLE

Public Api V6 Get Appointment Options Response Example

1 fields

EXAMPLE

Public Api V6 Get Available Dates Response Example

1 fields

EXAMPLE

Public Api V6 Get Bookable Items Response Example

2 fields

EXAMPLE

Public Api V6 Get Categories Response Example

2 fields

EXAMPLE

Public Api V6 Get Class Descriptions Response Example

2 fields

EXAMPLE

Public Api V6 Get Class Schedules Response Example

2 fields

EXAMPLE

Public Api V6 Get Class Visits Response Example

1 fields

EXAMPLE

Public Api V6 Get Classes Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Account Balances Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Complete Info Response Example

5 fields

EXAMPLE

Public Api V6 Get Client Contracts Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Duplicates Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Formula Notes Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Indexes Response Example

1 fields

EXAMPLE

Public Api V6 Get Client Purchases Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Referral Types Response Example

1 fields

EXAMPLE

Public Api V6 Get Client Rewards Response Example

3 fields

EXAMPLE

Public Api V6 Get Client Schedule Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Services Response Example

2 fields

EXAMPLE

Public Api V6 Get Client Visits Response Example

2 fields

EXAMPLE

Public Api V6 Get Clients Response Example

2 fields

EXAMPLE

Public Api V6 Get Commissions Response Example

2 fields

EXAMPLE

Public Api V6 Get Contact Log Types Response Example

2 fields

EXAMPLE

Public Api V6 Get Contact Logs Response Example

2 fields

EXAMPLE

Public Api V6 Get Contracts Response Example

2 fields

EXAMPLE

Public Api V6 Get Courses Reponse Example

2 fields

EXAMPLE

Public Api V6 Get Cross Regional Client Associations Response Example

2 fields

EXAMPLE

Public Api V6 Get Custom Client Fields Response Example

2 fields

EXAMPLE

Public Api V6 Get Custom Payment Methods Response Example

2 fields

EXAMPLE

Public Api V6 Get Enrollments Response Example

2 fields

EXAMPLE

Public Api V6 Get Genders Response Example

1 fields

EXAMPLE

Public Api V6 Get Gift Card Balance Response Example

2 fields

EXAMPLE

Public Api V6 Get Gift Card Response Example

2 fields

EXAMPLE

Public Api V6 Get Liability Waiver Response Example

1 fields

EXAMPLE

Public Api V6 Get Locations Response Example

2 fields

EXAMPLE

Public Api V6 Get Memberships Response Example

1 fields

EXAMPLE

Public Api V6 Get Mobile Providers Response Example

1 fields

EXAMPLE

Public Api V6 Get Packages Response Example

2 fields

EXAMPLE

Public Api V6 Get Payment Types Response Example

1 fields

EXAMPLE

Public Api V6 Get Pick Aspot Class Response Example

3 fields

EXAMPLE

Public Api V6 Get Products Inventory Response Example

2 fields

EXAMPLE

Public Api V6 Get Products Response Example

2 fields

EXAMPLE

Public Api V6 Get Programs Response Example

2 fields

EXAMPLE

Public Api V6 Get Promo Codes Response Example

2 fields

EXAMPLE

Public Api V6 Get Prospect Stages Response Example

1 fields

EXAMPLE

Public Api V6 Get Relationships Response Example

2 fields

EXAMPLE

Public Api V6 Get Required Client Fields Response Example

1 fields

EXAMPLE

Public Api V6 Get Reservation Response Example

3 fields

EXAMPLE

Public Api V6 Get Resource Availabilities Response Example

2 fields

EXAMPLE

Public Api V6 Get Sales Reps Response Example

2 fields

EXAMPLE

Public Api V6 Get Sales Response Example

2 fields

EXAMPLE

Public Api V6 Get Schedule Items Response Example

2 fields

EXAMPLE

Public Api V6 Get Scheduled Service Earnings Response Example

2 fields

EXAMPLE

Public Api V6 Get Semesters Response Example

2 fields

EXAMPLE

Public Api V6 Get Services Response Example

2 fields

EXAMPLE

Public Api V6 Get Session Types Response Example

2 fields

EXAMPLE

Public Api V6 Get Sites Response Example

2 fields

EXAMPLE

Public Api V6 Get Staff Appointments Response Example

2 fields

EXAMPLE

Public Api V6 Get Staff Image Urlresponse Example

2 fields

EXAMPLE

Public Api V6 Get Staff Permissions Response Example

1 fields

EXAMPLE

Public Api V6 Get Staff Response Example

2 fields

EXAMPLE

Public Api V6 Get Staff Session Types Response Example

2 fields

EXAMPLE

Public Api V6 Get Time Cards Response Example

2 fields

EXAMPLE

Public Api V6 Get Tips Response Example

2 fields

EXAMPLE

Public Api V6 Get Transactions Response Example

2 fields

EXAMPLE

Public Api V6 Get Unavailabilities Response Example

2 fields

EXAMPLE

Public Api V6 Get Waitlist Entries Response Example

2 fields

EXAMPLE

Public Api V6 Gift Card Example

12 fields

EXAMPLE

Public Api V6 Gift Card Layout Example

3 fields

EXAMPLE

Public Api V6 Http Content Example

1 fields

EXAMPLE

Public Api V6 Initiate Checkout Shopping Cart Using Alternative Payments Request Example

15 fields

EXAMPLE

Public Api V6 Initiate Purchase Contract Request Example

10 fields

EXAMPLE

Public Api V6 Issue Request Example

2 fields

EXAMPLE

Public Api V6 Issue Response Example

4 fields

EXAMPLE

Public Api V6 Lead Channel Example

5 fields

EXAMPLE

Public Api V6 Level Example

3 fields

EXAMPLE

Public Api V6 Liability Example

3 fields

EXAMPLE

Public Api V6 Location Example

25 fields

EXAMPLE

Public Api V6 Location1 Example

56 fields

EXAMPLE

Public Api V6 M0 Culture Neutral Public Key Token B77A5C561934E089 Example

2 fields

EXAMPLE

Public Api V6 Membership Example

14 fields

EXAMPLE

Public Api V6 Membership Type Restriction Example

2 fields

EXAMPLE

Public Api V6 Merge Clients Request Example

2 fields

EXAMPLE

Public Api V6 Mobile Provider Example

4 fields

EXAMPLE

Public Api V6 Package Example

6 fields

EXAMPLE

Public Api V6 Pagination Example

4 fields

EXAMPLE

Public Api V6 Pagination Response Example

4 fields

EXAMPLE

Public Api V6 Payment Processing Failure Example

3 fields

EXAMPLE

Public Api V6 Payment Type Example

4 fields

EXAMPLE

Public Api V6 Pick Aspot Class Example

11 fields

EXAMPLE

Public Api V6 Pricing Relationships Example

2 fields

EXAMPLE

Public Api V6 Product Example

20 fields

EXAMPLE

Public Api V6 Products Inventory Example

10 fields

EXAMPLE

Public Api V6 Program Example

6 fields

EXAMPLE

Public Api V6 Program Membership Example

2 fields

EXAMPLE

Public Api V6 Program1 Example

9 fields

EXAMPLE

Public Api V6 Promo Code Example

14 fields

EXAMPLE

Public Api V6 Prospect Stage Example

3 fields

EXAMPLE

Public Api V6 Purchase Account Credit Request Example

8 fields

EXAMPLE

Public Api V6 Purchase Account Credit Response Example

5 fields

EXAMPLE

Public Api V6 Purchase Contract Request Example

19 fields

EXAMPLE

Public Api V6 Purchase Contract Response Example

7 fields

EXAMPLE

Public Api V6 Purchase Contract Response Totals Example

4 fields

EXAMPLE

Public Api V6 Purchase Gift Card Request Example

17 fields

EXAMPLE

Public Api V6 Purchase Gift Card Response Example

11 fields

EXAMPLE

Public Api V6 Purchased Item Example

25 fields

EXAMPLE

Public Api V6 Relationship Example

3 fields

EXAMPLE

Public Api V6 Remove Client From Class Request Example

7 fields

EXAMPLE

Public Api V6 Remove Client From Class Response Example

1 fields

EXAMPLE

Public Api V6 Remove Clients From Classes Request Example

6 fields

EXAMPLE

Public Api V6 Remove Clients From Classes Response Example

3 fields

EXAMPLE

Public Api V6 Reservation Example

9 fields

EXAMPLE

Public Api V6 Resource Availability Example

3 fields

EXAMPLE

Public Api V6 Resource Availability1 Example

5 fields

EXAMPLE

Public Api V6 Resource Example

2 fields

EXAMPLE

Public Api V6 Resource Slim Example

2 fields

EXAMPLE

Public Api V6 Response Details Example

3 fields

EXAMPLE

Public Api V6 Return Sale Request Example

2 fields

EXAMPLE

Public Api V6 Return Sale Response Example

3 fields

EXAMPLE

Public Api V6 Sale Example

11 fields

EXAMPLE

Public Api V6 Sale Payment Example

6 fields

EXAMPLE

Public Api V6 Sales Rep Example

5 fields

EXAMPLE

Public Api V6 Sales Rep Response Example

4 fields

EXAMPLE

Public Api V6 Scheduled Service Earnings Event Example

5 fields

EXAMPLE

Public Api V6 Semester Example

8 fields

EXAMPLE

Public Api V6 Send Auto Email Request Example

2 fields

EXAMPLE

Public Api V6 Send Password Reset Email Request Example

3 fields

EXAMPLE

Public Api V6 Service Example

27 fields

EXAMPLE

Public Api V6 Service Tag Example

2 fields

EXAMPLE

Public Api V6 Session Type Example

13 fields

EXAMPLE

Public Api V6 Session Type1 Example

14 fields

EXAMPLE

Public Api V6 Shopping Cart Example

8 fields

EXAMPLE

Public Api V6 Site Example

23 fields

EXAMPLE

Public Api V6 Size Example

2 fields

EXAMPLE

Public Api V6 Spot Example

3 fields

EXAMPLE

Public Api V6 Staff Example

38 fields

EXAMPLE

Public Api V6 Staff Permission Group Example

4 fields

EXAMPLE

Public Api V6 Staff Session Type Example

15 fields

EXAMPLE

Public Api V6 Staff Setting Example

2 fields

EXAMPLE

Public Api V6 Staff1 Example

45 fields

EXAMPLE

Public Api V6 Stored Card Info Example

1 fields

EXAMPLE

Public Api V6 Sub Category Example

3 fields

EXAMPLE

Public Api V6 Substitute Class Teacher Request Example

6 fields

EXAMPLE

Public Api V6 Substitute Class Teacher Response Example

1 fields

EXAMPLE

Public Api V6 Substitute Teacher Class Example

21 fields

EXAMPLE

Public Api V6 Suspend Contract Request Example

9 fields

EXAMPLE

Public Api V6 Suspend Contract Response Example

1 fields

EXAMPLE

Public Api V6 Terminate Contract Request Example

5 fields

EXAMPLE

Public Api V6 Terminate Contract Response Example

1 fields

EXAMPLE

Public Api V6 Time Card Event Example

7 fields

EXAMPLE

Public Api V6 Tip Example

4 fields

EXAMPLE

Public Api V6 Transaction Example

17 fields

EXAMPLE

Public Api V6 Transaction Response Example

2 fields

EXAMPLE

Public Api V6 Unavailability Example

4 fields

EXAMPLE

Public Api V6 Unavailability Plain Example

5 fields

EXAMPLE

Public Api V6 Unavailability1 Example

4 fields

EXAMPLE

Public Api V6 Upcoming Autopay Event Example

7 fields

EXAMPLE

Public Api V6 Update Appointment Request Example

14 fields

EXAMPLE

Public Api V6 Update Appointment Response Example

1 fields

EXAMPLE

Public Api V6 Update Availability Request Example

9 fields

EXAMPLE

Public Api V6 Update Availability Response Example

2 fields

EXAMPLE

Public Api V6 Update Class Enrollment Schedule Request Example

24 fields

EXAMPLE

Public Api V6 Update Class Schedule Notes Request Example

1 fields

EXAMPLE

Public Api V6 Update Client Contract Autopays Request Example

7 fields

EXAMPLE

Public Api V6 Update Client Request Example

5 fields

EXAMPLE

Public Api V6 Update Client Response Example

1 fields

EXAMPLE

Public Api V6 Update Client Rewards Request Example

6 fields

EXAMPLE

Public Api V6 Update Client Service Request Example

5 fields

EXAMPLE

Public Api V6 Update Client Service Response Example

1 fields

EXAMPLE

Public Api V6 Update Client Visit Request Example

7 fields

EXAMPLE

Public Api V6 Update Client Visit Response Example

1 fields

EXAMPLE

Public Api V6 Update Contact Log Comment Example

2 fields

EXAMPLE

Public Api V6 Update Contact Log Request Example

10 fields

EXAMPLE

Public Api V6 Update Contact Log Type Example

2 fields

EXAMPLE

Public Api V6 Update Product Price Request Example

3 fields

EXAMPLE

Public Api V6 Update Product Price Response Example

1 fields

EXAMPLE

Public Api V6 Update Reservation Response Example

2 fields

EXAMPLE

Public Api V6 Update Sale Date Request Example

2 fields

EXAMPLE

Public Api V6 Update Sale Date Response Example

1 fields

EXAMPLE

Public Api V6 Update Service Response Example

1 fields

EXAMPLE

Public Api V6 Update Site Client Index Request Example

10 fields

EXAMPLE

Public Api V6 Update Site Client Index Response Example

10 fields

EXAMPLE

Public Api V6 Update Staff Permissions Request Example

2 fields

EXAMPLE

Public Api V6 Update Staff Permissions Response Example

1 fields

EXAMPLE

Public Api V6 Update Staff Request Example

28 fields

EXAMPLE

Public Api V6 Update Staff Response Example

1 fields

EXAMPLE

Public Api V6 Upload Client Document Request Example

2 fields

EXAMPLE

Public Api V6 Upload Client Document Response Example

2 fields

EXAMPLE

Public Api V6 Upload Client Photo Request Example

2 fields

EXAMPLE

Public Api V6 Upload Client Photo Response Example

2 fields

EXAMPLE

Public Api V6 User Example

4 fields

EXAMPLE

Public Api V6 Visit Example

28 fields

EXAMPLE

Public Api V6 Visit Waitlist Info Example

2 fields

EXAMPLE

Public Api V6 Visit With Waitlist Info Example

29 fields

EXAMPLE

Public Api V6 Waitlist Entry Example

9 fields

EXAMPLE

Public Api V6 Written Class Schedules Info Example

2 fields

EXAMPLE

Webhooks Api Create Subscription Request Example

4 fields

EXAMPLE

Webhooks Api Create Subscription Response Example

11 fields

EXAMPLE

Webhooks Api Deactivate Subscription Response Example

4 fields

EXAMPLE

Webhooks Api Get Metrics Response Example

1 fields

EXAMPLE

Webhooks Api Get Subscriptions Response Example

1 fields

EXAMPLE

Webhooks Api Metric Example

8 fields

EXAMPLE

Webhooks Api Patch Subscription Request Example

5 fields

EXAMPLE

Webhooks Api Push Api Error Example

3 fields

EXAMPLE

Webhooks Api Push Api Result Create Subscription Response Example

3 fields

EXAMPLE

Webhooks Api Push Api Result Deactivate Subscription Response Example

3 fields

EXAMPLE

Webhooks Api Push Api Result Get Subscriptions Response Example

3 fields

EXAMPLE

Webhooks Api Push Api Result Subscription Example

3 fields

EXAMPLE

Webhooks Api Subscription Example

10 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Website
Website
🔗
Documentation
Documentation
🌐
DeveloperPortal
DeveloperPortal
🚀
GettingStarted
GettingStarted
📝
Signup
Signup
💰
Pricing
Pricing
💬
Support
Support
💬
FAQ
FAQ
🟢
StatusPage
StatusPage
👥
GitHubOrganization
GitHubOrganization
👥
Mindbody-API-SDKs
GitHubRepository
🔗
LinkedIn
LinkedIn
📄
ReleaseNotes
ReleaseNotes
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑ 
info:
  _postman_id: a9ed7761-c6a7-499b-bf79-af617d74cad3
  name: Mindbody Webhooks API
  description: "Subscription and delivery platform that pushes near real-time event notifications for sites, locations, appointments,\
    \ classes, clients, sales, and staff. Partners create and manage subscriptions over a REST control plane, and Mindbody\
    \ pushes JSON events to the registered webhook URL with HMAC-SHA256 signature verification. Authentication uses an API-Key\
    \ header issued via the Mindbody webhooks developer portal.\n\nContact Support:\n Name: Mindbody API Support"
  schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json
  createdAt: '2026-06-05T15:12:47.000Z'
  updatedAt: '2026-06-05T15:12:47.000Z'
  lastUpdatedBy: '35240'
  uid: 35240-a9ed7761-c6a7-499b-bf79-af617d74cad3
item:
- name: api
  item:
  - name: v1
    item:
    - name: metrics
      item:
      - name: Mindbody This Endpoint Gets Metrics for All the Subscriptions Associated with
        id: 1c4364e3-10e1-48f5-a246-324e7c0fed52
        protocolProfileBehavior:
          disableBodyPruning: true
        request:
          auth:
            type: apikey
            apikey:
            - key: key
              value: API-Key
              type: string
            - key: value
              value: '{{apiKey}}'
              type: string
            - key: in
              value: header
              type: string
          method: GET
          header:
          - key: Accept
            value: application/json
          url:
            raw: '{{baseUrl}}/api/v1/metrics'
            host:
            - '{{baseUrl}}'
            path:
            - api
            - v1
            - metrics
          description: This endpoint gets metrics for all the subscriptions associated with your Public API developer account.
        response:
        - id: 59ce29d4-b206-41be-84f2-b1616876b858
          name: OK
          originalRequest:
            method: GET
            header:
            - key: Accept
              value: application/json
            - description: 'Added as a part of security scheme: apikey'
              key: API-Key
              value: <API Key>
            url:
              raw: '{{baseUrl}}/api/v1/metrics'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - metrics
          status: OK
          code: 200
          _postman_previewlanguage: json
          header:
          - key: Content-Type
            value: application/json
          cookie: []
          responseTime: null
          body: "{\n  \"items\": [\n    {\n      \"creationDateTime\": \"<dateTime>\",\n      \"messagesAttempted\": \"<integer>\"\
            ,\n      \"messagesDelivered\": \"<integer>\",\n      \"messagesFailed\": \"<integer>\",\n      \"messagesUndelivered\"\
            : \"<integer>\",\n      \"status\": \"<string>\",\n      \"statusChangeDate\": \"<dateTime>\",\n      \"subscriptionId\"\
            : \"<string>\"\n    },\n    {\n      \"creationDateTime\": \"<dateTime>\",\n      \"messagesAttempted\": \"<integer>\"\
            ,\n      \"messagesDelivered\": \"<integer>\",\n      \"messagesFailed\": \"<integer>\",\n      \"messagesUndelivered\"\
            : \"<integer>\",\n      \"status\": \"<string>\",\n      \"statusChangeDate\": \"<dateTime>\",\n      \"subscriptionId\"\
            : \"<string>\"\n    }\n  ]\n}"
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-59ce29d4-b206-41be-84f2-b1616876b858
        - id: 1b4ee25c-b031-4bd1-823d-8afce8b73cb2
          name: Bad Request
          originalRequest:
            method: GET
            header:
            - description: 'Added as a part of security scheme: apikey'
              key: API-Key
              value: <API Key>
            url:
              raw: '{{baseUrl}}/api/v1/metrics'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - metrics
          status: Bad Request
          code: 400
          _postman_previewlanguage: text
          header: []
          cookie: []
          responseTime: null
          body: null
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-1b4ee25c-b031-4bd1-823d-8afce8b73cb2
        - id: 134917eb-0674-4fdb-829e-8c08cffee63d
          name: Unauthorized
          originalRequest:
            method: GET
            header:
            - description: 'Added as a part of security scheme: apikey'
              key: API-Key
              value: <API Key>
            url:
              raw: '{{baseUrl}}/api/v1/metrics'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - metrics
          status: Unauthorized
          code: 401
          _postman_previewlanguage: text
          header: []
          cookie: []
          responseTime: null
          body: null
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-134917eb-0674-4fdb-829e-8c08cffee63d
        - id: b69980f1-7530-496b-8038-40b88c73e04e
          name: Forbidden
          originalRequest:
            method: GET
            header:
            - description: 'Added as a part of security scheme: apikey'
              key: API-Key
              value: <API Key>
            url:
              raw: '{{baseUrl}}/api/v1/metrics'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - metrics
          status: Forbidden
          code: 403
          _postman_previewlanguage: text
          header: []
          cookie: []
          responseTime: null
          body: null
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-b69980f1-7530-496b-8038-40b88c73e04e
        - id: 8e2f6188-f924-4b73-9983-110421fa95f0
          name: Not Found
          originalRequest:
            method: GET
            header:
            - description: 'Added as a part of security scheme: apikey'
              key: API-Key
              value: <API Key>
            url:
              raw: '{{baseUrl}}/api/v1/metrics'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - metrics
          status: Not Found
          code: 404
          _postman_previewlanguage: text
          header: []
          cookie: []
          responseTime: null
          body: null
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-8e2f6188-f924-4b73-9983-110421fa95f0
        - id: 4f8935f9-365d-4ff0-bef1-8ae0bd3a177a
          name: Internal Server Error
          originalRequest:
            method: GET
            header:
            - description: 'Added as a part of security scheme: apikey'
              key: API-Key
              value: <API Key>
            url:
              raw: '{{baseUrl}}/api/v1/metrics'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - metrics
          status: Internal Server Error
          code: 500
          _postman_previewlanguage: text
          header: []
          cookie: []
          responseTime: null
          body: null
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-4f8935f9-365d-4ff0-bef1-8ae0bd3a177a
        createdAt: '2026-06-05T15:12:48.000Z'
        updatedAt: '2026-06-05T15:12:48.000Z'
        uid: 35240-1c4364e3-10e1-48f5-a246-324e7c0fed52
      id: 987ed457-da61-4c8b-8d8f-5f6a04eda542
      createdAt: '2026-06-05T15:12:48.000Z'
      updatedAt: '2026-06-05T15:12:48.000Z'
      uid: 35240-987ed457-da61-4c8b-8d8f-5f6a04eda542
    - name: subscriptions
      item:
      - name: '{subscriptionId}'
        item:
        - name: Mindbody This Endpoint Deactivates a Subscription Associated with the Passed ID
          id: f4850aff-3d1b-4369-99bd-157cd0a8e1b8
          protocolProfileBehavior:
            disableBodyPruning: true
          request:
            auth:
              type: apikey
              apikey:
              - key: key
                value: API-Key
                type: string
              - key: value
                value: '{{apiKey}}'
                type: string
              - key: in
                value: header
                type: string
            method: DELETE
            header:
            - key: Accept
              value: application/json
            url:
              raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - subscriptions
              - :subscriptionId
              variable:
              - id: d54834a4-0ed0-4ffe-96a9-4cf0dfe641c0
                key: subscriptionId
                value: <string>
                description: (Required) The subscription ID (a GUID) that you are deactivating.
            description: This endpoint deactivates a subscription associated with the passed ID.
          response:
          - id: 70a6f341-ad6e-42a8-94d8-9de5e2a1ad44
            name: OK
            originalRequest:
              method: DELETE
              header:
              - key: Accept
                value: application/json
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: OK
            code: 200
            _postman_previewlanguage: json
            header:
            - key: Content-Type
              value: application/json
            cookie: []
            responseTime: null
            body: "{\n  \"errorInformation\": [\n    {\n      \"errorCode\": \"<integer>\",\n      \"errorMessage\": \"<string>\"\
              ,\n      \"errorType\": \"<string>\"\n    },\n    {\n      \"errorCode\": \"<integer>\",\n      \"errorMessage\"\
              : \"<string>\",\n      \"errorType\": \"<string>\"\n    }\n  ],\n  \"isSuccess\": \"<boolean>\",\n  \"value\"\
              : {\n    \"deactivationDateTime\": \"<dateTime>\",\n    \"message\": \"<string>\",\n    \"referenceId\": \"\
              <string>\",\n    \"subscriptionId\": \"<string>\"\n  }\n}"
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-70a6f341-ad6e-42a8-94d8-9de5e2a1ad44
          - id: b75a3a98-394f-4c0c-96ff-de41b6fbf0dd
            name: Bad Request
            originalRequest:
              method: DELETE
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Bad Request
            code: 400
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-b75a3a98-394f-4c0c-96ff-de41b6fbf0dd
          - id: 7f0ce09d-2cf7-4635-bda7-529c546cfc12
            name: Unauthorized
            originalRequest:
              method: DELETE
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Unauthorized
            code: 401
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-7f0ce09d-2cf7-4635-bda7-529c546cfc12
          - id: 3dfc775b-df34-4cd8-bafa-d5b88ef07de9
            name: Forbidden
            originalRequest:
              method: DELETE
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Forbidden
            code: 403
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-3dfc775b-df34-4cd8-bafa-d5b88ef07de9
          - id: a88eb604-7987-4d4c-8989-d05e664e74f3
            name: Not Found
            originalRequest:
              method: DELETE
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Not Found
            code: 404
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-a88eb604-7987-4d4c-8989-d05e664e74f3
          - id: 189d016d-cf0f-4fb6-8a54-d7567bfc2e06
            name: Internal Server Error
            originalRequest:
              method: DELETE
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Internal Server Error
            code: 500
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-189d016d-cf0f-4fb6-8a54-d7567bfc2e06
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-f4850aff-3d1b-4369-99bd-157cd0a8e1b8
        - name: Mindbody This Endpoint Finds and Returns the Single Subscription Associated
          id: 6cdabc19-cd70-4c9e-a7ed-9ea71d282bf2
          protocolProfileBehavior:
            disableBodyPruning: true
          request:
            auth:
              type: apikey
              apikey:
              - key: key
                value: API-Key
                type: string
              - key: value
                value: '{{apiKey}}'
                type: string
              - key: in
                value: header
                type: string
            method: GET
            header:
            - key: Accept
              value: application/json
            url:
              raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - subscriptions
              - :subscriptionId
              variable:
              - id: f3621b05-b20b-43cf-a71a-48fee737f2e0
                key: subscriptionId
                value: <string>
                description: (Required) Returns the single location identified by this ID (a GUID).
            description: This endpoint finds and returns the single subscription associated with the passed ID.
          response:
          - id: c082965f-f426-41d0-b82f-38fe11531aa1
            name: OK
            originalRequest:
              method: GET
              header:
              - key: Accept
                value: application/json
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: OK
            code: 200
            _postman_previewlanguage: json
            header:
            - key: Content-Type
              value: application/json
            cookie: []
            responseTime: null
            body: "{\n  \"errorInformation\": [\n    {\n      \"errorCode\": \"<integer>\",\n      \"errorMessage\": \"<string>\"\
              ,\n      \"errorType\": \"<string>\"\n    },\n    {\n      \"errorCode\": \"<integer>\",\n      \"errorMessage\"\
              : \"<string>\",\n      \"errorType\": \"<string>\"\n    }\n  ],\n  \"isSuccess\": \"<boolean>\",\n  \"value\"\
              : {\n    \"eventIds\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"eventSchemaVersion\": \"<double>\"\
              ,\n    \"referenceId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"statusChangeDate\": \"<dateTime>\"\
              ,\n    \"statusChangeMessage\": \"<string>\",\n    \"statusChangeUser\": \"<string>\",\n    \"subscriptionCreationDateTime\"\
              : \"<dateTime>\",\n    \"subscriptionId\": \"<string>\",\n    \"webhookUrl\": \"<string>\"\n  }\n}"
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-c082965f-f426-41d0-b82f-38fe11531aa1
          - id: 8557ead2-9f97-471c-973c-aef3ecf38463
            name: Bad Request
            originalRequest:
              method: GET
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Bad Request
            code: 400
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-8557ead2-9f97-471c-973c-aef3ecf38463
          - id: 1b3d3d98-fe16-4fca-9617-9d6733f4a559
            name: Unauthorized
            originalRequest:
              method: GET
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Unauthorized
            code: 401
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-1b3d3d98-fe16-4fca-9617-9d6733f4a559
          - id: 3c632245-9e72-4679-a1cc-4c38f040937f
            name: Forbidden
            originalRequest:
              method: GET
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Forbidden
            code: 403
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-3c632245-9e72-4679-a1cc-4c38f040937f
          - id: 80c0aec7-3339-4335-b6e6-5b33e389133a
            name: Not Found
            originalRequest:
              method: GET
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Not Found
            code: 404
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-80c0aec7-3339-4335-b6e6-5b33e389133a
          - id: d4c030b2-79dd-4938-bff3-2a122af5c7f6
            name: Internal Server Error
            originalRequest:
              method: GET
              header:
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Internal Server Error
            code: 500
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-d4c030b2-79dd-4938-bff3-2a122af5c7f6
          createdAt: '2026-06-05T15:12:48.000Z'
          updatedAt: '2026-06-05T15:12:48.000Z'
          uid: 35240-6cdabc19-cd70-4c9e-a7ed-9ea71d282bf2
        - name: Mindbody This Endpoint Can Activate a New Subscription or Reactivate an
          id: d336c57d-db5f-40b5-b382-6c72f9eb7ab4
          protocolProfileBehavior:
            disableBodyPruning: true
          request:
            auth:
              type: apikey
              apikey:
              - key: key
                value: API-Key
                type: string
              - key: value
                value: '{{apiKey}}'
                type: string
              - key: in
                value: header
                type: string
            method: PATCH
            header:
            - key: Content-Type
              value: application/json
            - key: Accept
              value: application/json
            body:
              mode: raw
              raw: "{\n  \"eventIds\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"eventSchemaVersion\": \"<double>\"\
                ,\n  \"referenceId\": \"<string>\",\n  \"status\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"
              options:
                raw:
                  headerFamily: json
                  language: json
            url:
              raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
              host:
              - '{{baseUrl}}'
              path:
              - api
              - v1
              - subscriptions
              - :subscriptionId
              variable:
              - id: 7a93988f-bd9c-4361-bc65-fd7908f29509
                key: subscriptionId
                value: <string>
                description: (Required) The subscription’s ID (a GUID).
            description: This endpoint can activate a new subscription or reactivate an inactive subscription that is associated
              with your developer portal account, by updating the status. You can also update your subscription’s eventIds,
              eventSchemaVersion, referenceId, and webhookUrl.
          response:
          - id: 5f12be04-d9f9-45c9-b719-2ffda7871d66
            name: OK
            originalRequest:
              method: PATCH
              header:
              - key: Content-Type
                value: application/json
              - key: Accept
                value: application/json
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              body:
                mode: raw
                raw: "{\n  \"eventIds\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"eventSchemaVersion\": \"<double>\"\
                  ,\n  \"referenceId\": \"<string>\",\n  \"status\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"
                options:
                  raw:
                    headerFamily: json
                    language: json
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: OK
            code: 200
            _postman_previewlanguage: json
            header:
            - key: Content-Type
              value: application/json
            cookie: []
            responseTime: null
            body: "{\n  \"errorInformation\": [\n    {\n      \"errorCode\": \"<integer>\",\n      \"errorMessage\": \"<string>\"\
              ,\n      \"errorType\": \"<string>\"\n    },\n    {\n      \"errorCode\": \"<integer>\",\n      \"errorMessage\"\
              : \"<string>\",\n      \"errorType\": \"<string>\"\n    }\n  ],\n  \"isSuccess\": \"<boolean>\",\n  \"value\"\
              : {\n    \"eventIds\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"eventSchemaVersion\": \"<double>\"\
              ,\n    \"referenceId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"statusChangeDate\": \"<dateTime>\"\
              ,\n    \"statusChangeMessage\": \"<string>\",\n    \"statusChangeUser\": \"<string>\",\n    \"subscriptionCreationDateTime\"\
              : \"<dateTime>\",\n    \"subscriptionId\": \"<string>\",\n    \"webhookUrl\": \"<string>\"\n  }\n}"
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-5f12be04-d9f9-45c9-b719-2ffda7871d66
          - id: 44521e8d-2016-4269-a7bd-25b699b3ce17
            name: Bad Request
            originalRequest:
              method: PATCH
              header:
              - key: Content-Type
                value: application/json
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              body:
                mode: raw
                raw: "{\n  \"eventIds\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"eventSchemaVersion\": \"<double>\"\
                  ,\n  \"referenceId\": \"<string>\",\n  \"status\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"
                options:
                  raw:
                    headerFamily: json
                    language: json
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Bad Request
            code: 400
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-44521e8d-2016-4269-a7bd-25b699b3ce17
          - id: 51a74b8a-6f4d-4320-a85b-b4e5bfc257ca
            name: Unauthorized
            originalRequest:
              method: PATCH
              header:
              - key: Content-Type
                value: application/json
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              body:
                mode: raw
                raw: "{\n  \"eventIds\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"eventSchemaVersion\": \"<double>\"\
                  ,\n  \"referenceId\": \"<string>\",\n  \"status\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"
                options:
                  raw:
                    headerFamily: json
                    language: json
              url:
                raw: '{{baseUrl}}/api/v1/subscriptions/:subscriptionId'
                host:
                - '{{baseUrl}}'
                path:
                - api
                - v1
                - subscriptions
                - :subscriptionId
                variable:
                - key: subscriptionId
            status: Unauthorized
            code: 401
            _postman_previewlanguage: text
            header: []
            cookie: []
            responseTime: null
            body: null
            createdAt: '2026-06-05T15:12:48.000Z'
            updatedAt: '2026-06-05T15:12:48.000Z'
            uid: 35240-51a74b8a-6f4d-4320-a85b-b4e5bfc257ca
          - id: fc005d6b-1e26-49c9-9f0a-dab0a0b7c6fa
            name: Forbidden
            originalRequest:
              method: PATCH
              header:
              - key: Content-Type
                value: application/json
              - description: 'Added as a part of security scheme: apikey'
                key: API-Key
                value: <API Key>
              body:
                mode: raw
                raw: "{\n  \"eventIds\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"eventSchemaVersion\": \"<double>\"\
                  ,\n  \"referenceId\": \"<string>\",\n  \"status\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"
                options:
                  raw:
            

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/apis.yml