Mindbody Enrollment API

openapi: 3.2.0
info:
  title: Mindbody Public API v6 Enrollment API
  version: '6.0'
  description: REST API for Mindbody business management data including appointments, classes, clients, enrollments, sales, sites, staff, payroll, and cross-site operations. Authentication combines a Mindbody-issued API-Key header with a SiteId header and optional staff/user OAuth bearer tokens for write operations. Generated from the official Mindbody Public API Python SDK (apimatic v3).
  contact:
    name: Mindbody API Support
    url: https://support.mindbodyonline.com/s/contactapisupport
  license:
    name: Proprietary
  x-generated-from: Mindbody-API-SDKs python SDK
  x-last-validated: '2026-05-28'
servers:
- url: https://api.mindbodyonline.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Enrollment
  description: Enrollment operations.
paths:
  /public/v6/enrollment/enrollments:
    get:
      tags:
      - Enrollment
      summary: Mindbody Returns a List of Enrollments. an Enrollment is a Service, Such as a
      description: 'Returns a list of enrollments. An enrollment is a service, such as a workshop or an event, that a staff member offers to multiple students, who commit to coming to all or most of the scheduled sessions. Enrollments typically run for a limited time only. When a user token is not passed with the request or the passed user token has insufficient viewing permissions, only the following staff data is returned in the response: * FirstName * LastName * Id * Bio * DisplayName * ImageUrl'
      operationId: getEnrollments
      parameters:
      - name: version
        in: path
        required: true
        description: version of the api.
        schema:
          type: string
        example: example-value
      - name: siteId
        in: header
        required: true
        description: ID of the site from which to pull data.
        schema:
          type: string
        example: example-value
      - name: authorization
        in: header
        required: false
        description: A staff user authorization token.
        schema:
          type: string
        example: example-value
      - name: request.classScheduleIds
        in: query
        required: false
        description: A list of the requested class schedule IDs. If omitted, all class schedule IDs return.
        schema:
          type: array
          items:
            type: integer
            format: int32
        example:
        - 1
      - name: request.endDate
        in: query
        required: false
        description: 'The end of the date range. The response returns any active enrollments that occur on or before this day.<br /> Default: **StartDate**'
        schema:
          type: string
          format: date-time
        example: '2026-05-28T14:30:00Z'
      - name: request.limit
        in: query
        required: false
        description: Number of results to include, defaults to 100
        schema:
          type: integer
          format: int32
        example: 1
      - name: request.locationIds
        in: query
        required: false
        description: List of the IDs for the requested locations. If omitted, all location IDs return.
        schema:
          type: array
          items:
            type: integer
            format: int32
        example:
        - 1
      - name: request.offset
        in: query
        required: false
        description: Page offset, defaults to 0.
        schema:
          type: integer
          format: int32
        example: 1
      - name: request.programIds
        in: query
        required: false
        description: List of the IDs for the requested programs. If omitted, all program IDs return.
        schema:
          type: array
          items:
            type: integer
            format: int32
        example:
        - 1
      - name: request.sessionTypeIds
        in: query
        required: false
        description: List of the IDs for the requested session types. If omitted, all session types IDs return.
        schema:
          type: array
          items:
            type: integer
            format: int32
        example:
        - 1
      - name: request.staffIds
        in: query
        required: false
        description: List of the IDs for the requested staff IDs. If omitted, all staff IDs return.
        schema:
          type: array
          items:
            type: integer
            format: int32
        example:
        - 1
      - name: request.startDate
        in: query
        required: false
        description: 'The start of the date range. The response returns any active enrollments that occur on or after this day.<br /> Default: **today’s date**'
        schema:
          type: string
          format: date-time
        example: '2026-05-28T14:30:00Z'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnrollmentsResponse'
              examples:
                Getenrollments200Example:
                  summary: Default getEnrollments 200 example
                  x-microcks-default: true
                  value:
                    PaginationResponse: {}
                    Enrollments:
                    - {}
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ApiKeyAuth: []
  /public/v6/enrollment/addclienttoenrollment:
    post:
      tags:
      - Enrollment
      summary: Mindbody Book a Client Into an Enrollment
      description: Book a client into an enrollment.
      operationId: addClientToEnrollment
      parameters:
      - name: version
        in: path
        required: true
        description: version of the api.
        schema:
          type: string
        example: example-value
      - name: siteId
        in: header
        required: true
        description: ID of the site from which to pull data.
        schema:
          type: string
        example: example-value
      - name: authorization
        in: header
        required: false
        description: A staff user authorization token.
        schema:
          type: string
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddClientToEnrollmentRequest'
            examples:
              AddclienttoenrollmentRequestExample:
                summary: Default addClientToEnrollment request example
                x-microcks-default: true
                value:
                  ClientId: example-value
                  ClassScheduleId: 123456
                  EnrollDateForward: '2026-05-28T14:30:00Z'
                  EnrollOpen:
                  - '2026-05-28T14:30:00Z'
                  Test: true
                  SendEmail: true
                  Waitlist: true
                  WaitlistEntryId: 123456
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassSchedule'
              examples:
                Addclienttoenrollment200Example:
                  summary: Default addClientToEnrollment 200 example
                  x-microcks-default: true
                  value:
                    Classes:
                    - {}
                    Clients:
                    - {}
                    Course: {}
                    SemesterId: 123456
                    IsAvailable: true
                    Id: 123456
                    ClassDescription: {}
                    DaySunday: true
                    DayMonday: true
                    DayTuesday: true
                    DayWednesday: true
                    DayThursday: true
                    DayFriday: true
                    DaySaturday: true
                    AllowOpenEnrollment: true
                    AllowDateForwardEnrollment: true
                    StartTime: '2026-05-28T14:30:00Z'
                    EndTime: '2026-05-28T14:30:00Z'
                    StartDate: '2026-05-28T14:30:00Z'
                    EndDate: '2026-05-28T14:30:00Z'
                    Staff: {}
                    Location: {}
                    FrequencyType: {}
                    FrequencyInterval: 1
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ApiKeyAuth: []
  /public/v6/enrollment/addenrollmentschedule:
    post:
      tags:
      - Enrollment
      summary: Mindbody This Endpoint Adds a Enrollment Schedule. You Can Require Clients to
      description: This endpoint adds a enrollment schedule. You can require clients to sign up for the entire enrollment schedule or allow them to pick specific sessions using the AllowOpenEnrollment parameter.
      operationId: addEnrollmentSchedule
      parameters:
      - name: version
        in: path
        required: true
        description: version of the api.
        schema:
          type: string
        example: example-value
      - name: siteId
        in: header
        required: true
        description: ID of the site from which to pull data.
        schema:
          type: string
        example: example-value
      - name: authorization
        in: header
        required: false
        description: A staff user authorization token.
        schema:
          type: string
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddClassEnrollmentScheduleRequest'
            examples:
              AddenrollmentscheduleRequestExample:
                summary: Default addEnrollmentSchedule request example
                x-microcks-default: true
                value:
                  ClassDescriptionId: 123456
                  LocationId: 123456
                  StartDate: '2026-05-28T14:30:00Z'
                  EndDate: '2026-05-28T14:30:00Z'
                  StartTime: '2026-05-28T14:30:00Z'
                  EndTime: '2026-05-28T14:30:00Z'
                  DaySunday: true
                  DayMonday: true
                  DayTuesday: true
                  DayWednesday: true
                  DayThursday: true
                  DayFriday: true
                  DaySaturday: true
                  StaffId: 123456
                  StaffPayRate: 1
                  ResourceId: 123456
                  MaxCapacity: 1
                  WebCapacity: 1
                  WaitlistCapacity: 1
                  BookingStatus: Active
                  AllowOpenEnrollment: true
                  AllowDateForwardEnrollment: true
                  PricingOptionsProductIds:
                  - 1
                  ShowToPublic: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WrittenClassSchedulesInfo'
              examples:
                Addenrollmentschedule200Example:
                  summary: Default addEnrollmentSchedule 200 example
                  x-microcks-default: true
                  value:
                    ClassId: 123456
                    ClassInstanceIds:
                    - 1
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ApiKeyAuth: []
  /public/v6/enrollment/updateenrollmentschedule:
    post:
      tags:
      - Enrollment
      summary: Mindbody This Endpoint Update a Enrollment Schedule
      description: This endpoint update a enrollment schedule.
      operationId: updateEnrollmentSchedule
      parameters:
      - name: version
        in: path
        required: true
        description: version of the api.
        schema:
          type: string
        example: example-value
      - name: siteId
        in: header
        required: true
        description: ID of the site from which to pull data.
        schema:
          type: string
        example: example-value
      - name: authorization
        in: header
        required: false
        description: A staff user authorization token.
        schema:
          type: string
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClassEnrollmentScheduleRequest'
            examples:
              UpdateenrollmentscheduleRequestExample:
                summary: Default updateEnrollmentSchedule request example
                x-microcks-default: true
                value:
                  ClassId: 123456
                  ClassDescriptionId: 123456
                  LocationId: 123456
                  StartDate: '2026-05-28T14:30:00Z'
                  EndDate: '2026-05-28T14:30:00Z'
                  StartTime: '2026-05-28T14:30:00Z'
                  EndTime: '2026-05-28T14:30:00Z'
                  DaySunday: true
                  DayMonday: true
                  DayTuesday: true
                  DayWednesday: true
                  DayThursday: true
                  DayFriday: true
                  DaySaturday: true
                  StaffId: 123456
                  StaffPayRate: 1
                  ResourceId: 123456
                  MaxCapacity: 1
                  WebCapacity: 1
                  WaitlistCapacity: 1
                  BookingStatus: Active
                  AllowOpenEnrollment: true
                  AllowDateForwardEnrollment: true
                  RetainScheduleChanges: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WrittenClassSchedulesInfo'
              examples:
                Updateenrollmentschedule200Example:
                  summary: Default updateEnrollmentSchedule 200 example
                  x-microcks-default: true
                  value:
                    ClassId: 123456
                    ClassInstanceIds:
                    - 1
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ApiKeyAuth: []
components:
  schemas:
    Unavailability:
      type: object
      description: Implementation of the 'Unavailability' model.
      properties:
        Id:
          type: integer
          format: int32
          description: The ID of the unavailability.
          example: 123456
        StartDateTime:
          type: string
          format: date-time
          description: The date and time the unavailability starts.
          example: '2026-05-28T14:30:00Z'
        EndDateTime:
          type: string
          format: date-time
          description: The date and time the unavailability ends.
          example: '2026-05-28T14:30:00Z'
        Description:
          type: string
          description: A description of the unavailability.
          example: Example note for Mindbody Public API.
    ClientRelationship:
      type: object
      description: Implementation of the 'ClientRelationship' model. A relation between two clients.
      properties:
        RelatedClientId:
          type: string
          description: The RSSID of the related client.
          example: example-value
        RelatedUniqueId:
          type: integer
          format: int32
          description: The UniqueId of the related client.
          example: 123456
        Relationship:
          $ref: '#/components/schemas/Relationship'
          description: Contains details about the relationship between two clients.
        RelationshipName:
          type: string
          description: The name of the relationship of the related client.
          example: example-value
        Delete:
          type: boolean
          description: 'When true, the associated relationship is removed from the client’s list of relationships. This property is ignored in all other use cases. Default: *false*'
          example: true
    GetEnrollmentsResponse:
      type: object
      description: Implementation of the 'GetEnrollmentsResponse' model.
      properties:
        PaginationResponse:
          $ref: '#/components/schemas/PaginationResponse'
          description: Contains information about the pagination used.
        Enrollments:
          type: array
          items:
            $ref: '#/components/schemas/ClassSchedule'
          description: Contains information about the enrollments.
          example:
          - {}
    AppointmentGenderPreference1Enum:
      type: string
      description: AppointmentGenderPreference1Enum enumeration.
      enum:
      - None
      - Female
      - Male
    AppointmentStatusEnum:
      type: string
      description: AppointmentStatusEnum enumeration.
      enum:
      - None
      - Requested
      - Booked
      - Completed
      - Confirmed
      - Arrived
      - NoShow
      - Cancelled
      - LateCancelled
    ClientService:
      type: object
      description: Implementation of the 'ClientService' model. A service that is on a client's account.
      properties:
        ActiveDate:
          type: string
          format: date-time
          description: The date that this pricing option became active and could be used to pay for services.
          example: '2026-05-28T14:30:00Z'
        Count:
          type: integer
          format: int32
          description: The number of service sessions this pricing option contained when first purchased.
          example: 10
        Current:
          type: boolean
          description: When `true`, there are service sessions remaining on the pricing option that can be used pay for the current session.<br /> When `false`, the client cannot use this pricing option to pay for other services.
          example: true
        ExpirationDate:
          type: string
          format: date-time
          description: The date when the pricing option expires and can no longer be used to pay for services, even if unused service sessions remain on the option; expressed as UTC.
          example: '2026-05-28T14:30:00Z'
        Id:
          type: integer
          format: int32
          description: The unique ID assigned to this pricing option, specific to when it was purchased by the client.
          example: 123456
        ProductId:
          type: integer
          format: int32
          description: The unique ID of this pricing option, not specific to any client's purchase of it.
          example: 123456
        Name:
          type: string
          description: The name of this pricing option.
          example: Sunset Yoga Studio
        PaymentDate:
          type: string
          format: date-time
          description: The date on which the client paid for this pricing option.
          example: '2026-05-28T14:30:00Z'
        Program:
          $ref: '#/components/schemas/Program'
          description: Contains information about the service category this service falls under.
        Remaining:
          type: integer
          format: int32
          description: The number of service sessions remaining in the pricing option that can still be used.
          example: 1
        SiteId:
          type: integer
          format: int32
          description: The ID of the subscriber site associated with this pricing option.
          example: -99
        Action:
          $ref: '#/components/schemas/Action1Enum'
          description: The action taken.
        ClientID:
          type: string
          description: The Client ID assigned to this pricing option, specific to when it was purchased by the client.
          example: example-value
        Returned:
          type: boolean
          description: Identification for purchased service is returned or not.
          example: true
    ClientCreditCard:
      type: object
      description: Implementation of the 'ClientCreditCard' model. A client credit card.
      properties:
        Address:
          type: string
          description: The billing address for the credit card.
          example: 123 Market St
        CardHolder:
          type: string
          description: The name of the card holder.
          example: example-value
        CardNumber:
          type: string
          description: The credit card number.
          example: example-value
        CardType:
          type: string
          description: The type of credit card, for example Visa or MasterCard.
          example: example-value
        City:
          type: string
          description: The city in which the billing address is located.
          example: San Francisco
        ExpMonth:
          type: string
          description: The month in which the credit card expires.
          example: example-value
        ExpYear:
          type: string
          description: The year in which the credit card expires.
          example: example-value
        LastFour:
          type: string
          description: The last four digits of the credit card number.
          example: example-value
        PostalCode:
          type: string
          description: The postal code where the billing address is located.
          example: '94110'
        State:
          type: string
          description: The state that the billing address is located in.
          example: CA
    ScheduleTypeEnum:
      type: string
      description: ScheduleTypeEnum enumeration.
      enum:
      - All
      - Class
      - Enrollment
      - Appointment
      - Resource
      - Media
      - Arrival
    CustomClientFieldValue:
      type: object
      description: Implementation of the 'CustomClientFieldValue' model. The value of a custom client field
      properties:
        Value:
          type: string
          description: The value of a specific custom field for a client.
          example: example-value
        Id:
          type: integer
          format: int32
          description: The ID of the custom client field.
          example: 123456
        DataType:
          type: string
          description: The data type of the field.
          example: example-value
        Name:
          type: string
          description: The name of the field.
          example: Sunset Yoga Studio
    Staff:
      type: object
      description: Implementation of the 'Staff' model. The Staff
      properties:
        Address:
          type: string
          description: The address of the staff member who is teaching the class.
          example: 123 Market St
        AppointmentInstructor:
          type: boolean
          description: When `true`, indicates that the staff member offers appointments.<br /> When `false`, indicates that the staff member does not offer appointments.
          example: true
        AlwaysAllowDoubleBooking:
          type: boolean
          description: When `true`, indicates that the staff member can be scheduled for overlapping services.<br /> When `false`, indicates that the staff can only be scheduled for one service at a time in any given time-frame.
          example: true
        Bio:
          type: string
          description: The staff member’s biography. This string contains HTML.
          example: example-value
        City:
          type: string
          description: The staff member’s city.
          example: San Francisco
        Country:
          type: string
          description: The staff member’s country.
          example: US
        Email:
          type: string
          description: The staff member’s email address.
          example: kinlane@example.com
        FirstName:
          type: string
          description: The staff member’s first name.
          example: Alex
        DisplayName:
          type: string
          description: The staff member’s Nickname.
          example: example-value
        HomePhone:
          type: string
          description: The staff member’s home phone number.
          example: '+15551234567'
        Id:
          type: integer
          format: int32
          description: The ID assigned to the staff member.
          example: 123456
        IndependentContractor:
          type: boolean
          description: When `true`, indicates that the staff member is an independent contractor. When `false`, indicates that the staff member is not an independent contractor.
          example: true
        IsMale:
          type: boolean
          description: When `true`, indicates that the staff member is male. When `false`, indicates that the staff member is female.
          example: true
        LastName:
          type: string
          description: The staff member’s last name.
          example: Lane
        MobilePhone:
          type: string
          description: The staff member’s mobile phone number.
          example: '+15551234567'
        Name:
          type: string
          description: The staff member’s name.
          example: Sunset Yoga Studio
        PostalCode:
          type: string
          description: The staff member’s postal code.
          example: '94110'
        ClassTeacher:
          type: boolean
          description: When `true`, indicates that the staff member can teach classes. When `false`, indicates that the staff member cannot teach classes.
          example: true
        SortOrder:
          type: integer
          format: int32
          description: If configured by the business owner, this field determines a staff member’s weight when sorting. Use this field to sort staff members on your interface.
          example: 1
        State:
          type: string
          description: The staff member’s state.
          example: CA
        WorkPhone:
          type: string
          description: The staff member’s work phone number.
          example: '+15551234567'
        ImageUrl:
          type: string
          description: The URL of the staff member’s image, if one has been uploaded.
          example: https://example.mindbodyonline.com/resource/abc123
        ClassAssistant:
          type: boolean
          description: Is the staff an assistant
          example: true
        ClassAssistant2:
          type: boolean
          description: Is the staff an assistant2
          example: true
        EmploymentStart:
          type: string
          format: date-time
          description: The start date of employment
          example: '2026-05-28T14:30:00Z'
        EmploymentEnd:
          type: string
          format: date-time
          description: The end date of employment
          example: '2026-05-28T14:30:00Z'
        ProviderIDs:
          type: array
          items:
            type: string
          description: A list of ProviderIds for the staff.
          example:
          - example-value
        Rep:
          type: boolean
          description: return true if staff is sales Rep 1 else false.
          example: true
        Rep2:
          type: boolean
          description: return true if staff is sales Rep 2 else false.
          example: true
        Rep3:
          type: boolean
          description: return true if staff is sales Rep 3 else false.
          example: true
        Rep4:
          type: boolean
          description: return true if staff is sales Rep 4 else false.
          example: true
        Rep5:
          type: boolean
          description: return true if staff is sales Rep 5 else false.
          example: true
        Rep6:
          type: boolean
          description: return true if staff is sales Rep 6 else false.
          example: true
        StaffSettings:
          $ref: '#/components/schemas/StaffSetting'
          description: This object contains the staff settings.
        Appointments:
          type: array
          items:
            $ref: '#/components/schemas/Appointment'
          description: A list of appointments for the staff.
          example:
          - {}
        Unavailabilities:
          type: array
          items:
            $ref: '#/components/schemas/Unavailability'
          description: A list of unavailabilities for the staff.
          example:
          - {}
        Availabilities:
          type: array
          items:
            $ref: '#/components/schemas/Availability'
          description: A list of availabilities for the staff.
          example:
          - {}
        EmpID:
          type: string
          description: The EmpID assigned to the staff member.
          example: example-value
    Availability:
      type: object
      description: Implementation of the 'Availability' model. A staff availability entry
      properties:
        Id:
          type: integer
          format: int32
          description: The ID of the availability.
          example: 123456
        Staff:
          $ref: '#/components/schemas/Staff'
          description: Contains information about staff members.
        SessionType:
          $ref: '#/components/schemas/SessionType'
          description: Contains information about the types of sessions.
        Programs:
          type: array
          items:
            $ref: '#/components/schemas/Program'
          description: Contains information about the programs.
          example:
          - {}
        StartDateTime:
          type: string
          format: date-time
          description: The date and time the availability starts in the site local time zone.
          example: '2026-05-28T14:30:00Z'
        EndDateTime:
          type: string
          format: date-time
          description: The date and time the availability ends in the site local time zone.
          example: '2026-05-28T14:30:00Z'
        BookableEndDateTime:
          type: string
          format: date-time
          description: The time of day that the last appointment can start in the site local time zone.
          example: '2026-05-28T14:30:00Z'
        Location:
          $ref: '#/components/schemas/Location'
          description: Contains information about the location.
        PrepTime:
          type: integer
          format: int32
          description: Prep time in minutes
          example: 1
        FinishTime:
          type: integer
          format: int32
          description: Finish time in minutes
          example: 1
        IsMasked:
          type: boolean
          description: When `true`, indicates that the staff member's name for availabilty is masked. When `false`, indicates that the staff member's name for availabilty is not masked.
          example: true
        ShowPublic:
          type: boolean
          description: When `true`, indicates that the schedule is shown to the clients. When `false`, indicates that the schedule is hidden from the clients.
          example: true
        ResourceAvailabilities:
          type: array
          items:
            $ref: '#/components/schemas/ResourceAvailability'
          description: Contains information about resources availability for the specified session type.
          example:
          - {}
    AddOnSmall:
      type: object
      description: Implementation of the 'AddOnSmall' model.
      properties:
        Id:
          type: integer
          format: int32
          description: The unique ID of the appointment add-on booking.
          example: 123456
        Name:
          type: string
          description: The name of the appointment add-on.
          example: Sunset Yoga Studio
        StaffId:

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