Mindbody Public API v6 — Appointment

naftiko: 1.0.0-alpha2
info:
  label: "Mindbody Public API v6 \u2014 Appointment"
  description: "Appointment \u2014 17 operations. Lead operation: Mindbody This is Not Appointment Availability but Rather the Active Business. Self-contained Naftiko capability covering one Mindbody business\
    \ surface."
  tags:
  - Mindbody
  - Mindbody Public API v6
  - Appointment
  created: '2026-05-28'
  modified: '2026-05-28'
binds:
- namespace: env
  keys:
    MINDBODY_API_KEY: MINDBODY_API_KEY
capability:
  consumes:
  - type: http
    namespace: public-api-v6-appointment
    baseUri: https://api.mindbodyonline.com
    description: "Mindbody Public API v6 \u2014 Appointment business capability. Self-contained, no shared references."
    authentication:
      type: apikey
      key: API-Key
      value: '{{env.MINDBODY_API_KEY}}'
      placement: header
    resources:
    - name: appointment-activesessiontimes
      path: /appointment/activesessiontimes
      operations:
      - name: getActiveSessionTimes
        method: GET
        description: Mindbody This is Not Appointment Availability but Rather the Active Business
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.endTime
          in: query
          type: string
          required: false
          description: 'Filters results to times that end on or before this time on the current date. Any date provided is ignored.. <br />Default: **23:59:59**'
        - name: request.limit
          in: query
          type: integer
          required: false
          description: Number of results to include, defaults to 100
        - name: request.offset
          in: query
          type: integer
          required: false
          description: Page offset, defaults to 0.
        - name: request.scheduleType
          in: query
          type: string
          required: false
          description: Filters on the provided the schedule type. Either `SessionTypeIds` or `ScheduleType` must be provided.
        - name: request.sessionTypeIds
          in: query
          type: array
          required: false
          description: Filters on the provided session type IDs. Either `SessionTypeIds` or `ScheduleType` must be provided.
        - name: request.startTime
          in: query
          type: string
          required: false
          description: 'Filters results to times that start on or after this time on the current date. Any date provided is ignored. <br />Default: **00:00:00**'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-addons
      path: /appointment/addons
      operations:
      - name: getAddOns
        method: GET
        description: Mindbody Get Active Appointment Add-ons
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.limit
          in: query
          type: integer
          required: false
          description: Number of results to include, defaults to 100
        - name: request.offset
          in: query
          type: integer
          required: false
          description: Page offset, defaults to 0.
        - name: request.staffId
          in: query
          type: integer
          required: false
          description: Filter to add-ons only performed by this staff member.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-appointmentoptions
      path: /appointment/appointmentoptions
      operations:
      - name: getAppointmentOptions
        method: GET
        description: Mindbody This Endpoint Has No Query Parameters
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-availabledates
      path: /appointment/availabledates
      operations:
      - name: getAvailableDates
        method: GET
        description: Mindbody Returns a List of Dates to Narrow Down Staff Availability When
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: request.sessionTypeId
          in: query
          type: integer
          required: true
          description: required requested session type ID.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.endDate
          in: query
          type: string
          required: false
          description: 'The end date of the requested date range. <br />Default: **StartDate**'
        - name: request.locationId
          in: query
          type: integer
          required: false
          description: optional requested location ID.
        - name: request.staffId
          in: query
          type: integer
          required: false
          description: optional requested staff ID.
        - name: request.startDate
          in: query
          type: string
          required: false
          description: "The start date of the requested date range. If omitted, the default is used. <br />Default: **today\u2019s date**"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-bookableitems
      path: /appointment/bookableitems
      operations:
      - name: getBookableItems
        method: GET
        description: Mindbody Returns a List of Availabilities with the Information Needed to Book
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: request.sessionTypeIds
          in: query
          type: array
          required: true
          description: A list of the requested session type IDs.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.appointmentId
          in: query
          type: integer
          required: false
          description: If provided, filters out the appointment with this ID.
        - name: request.endDate
          in: query
          type: string
          required: false
          description: 'The end date of the requested date range. <br />Default: **StartDate**'
        - name: request.ignoreDefaultSessionLength
          in: query
          type: boolean
          required: false
          description: When `true`, availabilities that are non-default return, for example, a 30-minute availability with a 60-minute default session length.<br /> When `false`, only availabilities that
            have the default session length return.
        - name: request.includeResourceAvailability
          in: query
          type: boolean
          required: false
          description: When `true`, resource availabilities for the session type are returned.<br /> When `false`, resource availabilities are not returned default.
        - name: request.limit
          in: query
          type: integer
          required: false
          description: Number of results to include, defaults to 100
        - name: request.locationIds
          in: query
          type: array
          required: false
          description: A list of the requested location IDs.
        - name: request.offset
          in: query
          type: integer
          required: false
          description: Page offset, defaults to 0.
        - name: request.staffIds
          in: query
          type: array
          required: false
          description: A list of the requested staff IDs. Omit parameter to return all staff availabilities.
        - name: request.startDate
          in: query
          type: string
          required: false
          description: "The start date of the requested date range. <br />Default: **today\u2019s date**"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-scheduleitems
      path: /appointment/scheduleitems
      operations:
      - name: getScheduleItems
        method: GET
        description: Mindbody Returns a List of Schedule Items, Including Appointments,
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.endDate
          in: query
          type: string
          required: false
          description: "The end date of the requested date range. <br />Default: **today\u2019s date**"
        - name: request.ignorePrepFinishTimes
          in: query
          type: boolean
          required: false
          description: 'When `true`, appointment preparation and finish unavailabilities are not returned. <br />Default: **false**'
        - name: request.limit
          in: query
          type: integer
          required: false
          description: Number of results to include, defaults to 100
        - name: request.locationIds
          in: query
          type: array
          required: false
          description: A list of requested location IDs.
        - name: request.offset
          in: query
          type: integer
          required: false
          description: Page offset, defaults to 0.
        - name: request.staffIds
          in: query
          type: array
          required: false
          description: A list of requested staff IDs.
        - name: request.startDate
          in: query
          type: string
          required: false
          description: "The start date of the requested date range. <br />Default: **today\u2019s date**"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-staffappointments
      path: /appointment/staffappointments
      operations:
      - name: getStaffAppointments
        method: GET
        description: Mindbody Returns a List of Appointments by Staff Member
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.appointmentIds
          in: query
          type: array
          required: false
          description: A list of the requested appointment IDs.
        - name: request.clientId
          in: query
          type: string
          required: false
          description: The client ID to be returned.
        - name: request.endDate
          in: query
          type: string
          required: false
          description: 'The end date of the requested date range. <br />Default: **StartDate**'
        - name: request.limit
          in: query
          type: integer
          required: false
          description: Number of results to include, defaults to 100
        - name: request.locationIds
          in: query
          type: array
          required: false
          description: A list of the requested location IDs.
        - name: request.offset
          in: query
          type: integer
          required: false
          description: Page offset, defaults to 0.
        - name: request.staffIds
          in: query
          type: array
          required: false
          description: List of staff IDs to be returned. Omit parameter to return staff appointments for all staff.
        - name: request.startDate
          in: query
          type: string
          required: false
          description: 'The start date of the requested date range. If omitted, the default is used. <br />Default: **today''s date**'
        - name: request.useSiteSettingsStaffName
          in: query
          type: boolean
          required: false
          description: When `true`, the staff DisplayName will be populated based on site-level settings. When `false` or omitted, the staff DisplayName will contain only the FirstName.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-unavailabilities
      path: /appointment/unavailabilities
      operations:
      - name: getUnavailabilities
        method: GET
        description: Mindbody Returns a List of Unavailabilities. Unavailabilities Are the Times at
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: request.endDate
          in: query
          type: string
          required: false
          description: "The end date of the requested date range. <br />Default: **today\u2019s date**"
        - name: request.limit
          in: query
          type: integer
          required: false
          description: Number of results to include, defaults to 100
        - name: request.offset
          in: query
          type: integer
          required: false
          description: Page offset, defaults to 0.
        - name: request.staffIds
          in: query
          type: array
          required: false
          description: A list of requested staff IDs.
        - name: request.startDate
          in: query
          type: string
          required: false
          description: "The start date of the requested date range. <br />Default: **today\u2019s date**"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-addappointment
      path: /appointment/addappointment
      operations:
      - name: addAppointment
        method: POST
        description: Mindbody A User Token is Required for This Endpoint. to Book an Appointment,
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: body
          in: body
          type: object
          required: true
          description: JSON request body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-addappointmentaddon
      path: /appointment/addappointmentaddon
      operations:
      - name: addAppointmentAddOn
        method: POST
        description: Mindbody This Endpoint Books an Add-on on Top of an Existing, Regular
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: body
          in: body
          type: object
          required: true
          description: JSON request body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-addmultipleappointments
      path: /appointment/addmultipleappointments
      operations:
      - name: addMultipleAppointments
        method: POST
        description: Mindbody A User Token is Required for This Endpoint. to Book Appointments, You
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: body
          in: body
          type: object
          required: true
          description: JSON request body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-availabilities
      path: /appointment/availabilities
      operations:
      - name: updateAvailability
        method: PUT
        description: Mindbody To Update the Information for a Specific Availability or
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: body
          in: body
          type: object
          required: true
          description: JSON request body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addAvailabilities
        method: POST
        description: Mindbody Add Availabilities and Unavailabilities for a Staff Member.<br />
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: body
          in: body
          type: object
          required: true
          description: JSON request body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-updateappointment
      path: /appointment/updateappointment
      operations:
      - name: updateAppointment
        method: POST
        description: Mindbody To Update the Information for a Specific Appointment, You Must Have a
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: body
          in: body
          type: object
          required: true
          description: JSON request body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-appointmentfromwaitlist
      path: /appointment/appointmentfromwaitlist
      operations:
      - name: removeFromWaitlist
        method: DELETE
        description: Mindbody Remove an Appointment from Waitlist
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: request.waitlistEntryIds
          in: query
          type: array
          required: true
          description: A list of `WaitlistEntryIds` to remove from the waiting list.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-availability
      path: /appointment/availability
      operations:
      - name: deleteAvailability
        method: DELETE
        description: Mindbody This Endpoint Deletes the Availability or Unavailability
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        - name: deleteAvailabilityRequest.availabilityId
          in: query
          type: integer
          required: false
          description: The ID of the availability or unavailability.
        - name: deleteAvailabilityRequest.test
          in: query
          type: boolean
          required: false
          description: "When `true`, indicates that this is a test request and no data is deleted from the subscriber\u2019s database. When `false`, the record will be deleted. Default: **false**"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: appointment-deleteappointmentaddon
      path: /appointment/deleteappointmentaddon
      operations:
      - name: deleteAppointmentAddOn
        method: DELETE
        description: Mindbody This Endpoint Can Be Used to Early-cancel a Booked Appointment Add-on
        inputParameters:
        - name: version
          in: path
          type: string
          required: true
          description: version of the api.
        - name: id
          in: query
          type: integer
          required: true
          description: The request query parameter.
        - name: siteId
          in: header
          type: string
          required: true
          description: ID of the site from which to pull data.
        - name: authorization
          in: header
          type: string
          required: false
          description: A staff user authorization token.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: public-api-v6-appointment-rest
    port: 8080
    description: "REST adapter for Mindbody Public API v6 \u2014 Appointment. One Spectral-compliant resource per consumed operation, prefixed with /v1."
    resources:
    - path: /v1/appointment/activesessiontimes
      name: v1-appointment-activesessiontimes
      description: REST surface for /v1/appointment/activesessiontimes.
      operations:
      - method: GET
        name: getActiveSessionTimes
        description: Mindbody This is Not Appointment Availability but Rather the Active Business
        call: public-api-v6-appointment.getActiveSessionTimes
        with:
          version: rest.version
          siteId: rest.siteId
          authorization: rest.authorization
          request.endTime: rest.request.endTime
          request.limit: rest.request.limit
          request.offset: rest.request.offset
          request.scheduleType: rest.request.scheduleType
          request.sessionTypeIds: rest.request.sessionTypeIds
          request.startTime: rest.request.startTime
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/addons
      name: v1-appointment-addons
      description: REST surface for /v1/appointment/addons.
      operations:
      - method: GET
        name: getAddOns
        description: Mindbody Get Active Appointment Add-ons
        call: public-api-v6-appointment.getAddOns
        with:
          version: rest.version
          siteId: rest.siteId
          authorization: rest.authorization
          request.limit: rest.request.limit
          request.offset: rest.request.offset
          request.staffId: rest.request.staffId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/appointmentoptions
      name: v1-appointment-appointmentoptions
      description: REST surface for /v1/appointment/appointmentoptions.
      operations:
      - method: GET
        name: getAppointmentOptions
        description: Mindbody This Endpoint Has No Query Parameters
        call: public-api-v6-appointment.getAppointmentOptions
        with:
          version: rest.version
          siteId: rest.siteId
          authorization: rest.authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/availabledates
      name: v1-appointment-availabledates
      description: REST surface for /v1/appointment/availabledates.
      operations:
      - method: GET
        name: getAvailableDates
        description: Mindbody Returns a List of Dates to Narrow Down Staff Availability When
        call: public-api-v6-appointment.getAvailableDates
        with:
          version: rest.version
          request.sessionTypeId: rest.request.sessionTypeId
          siteId: rest.siteId
          authorization: rest.authorization
          request.endDate: rest.request.endDate
          request.locationId: rest.request.locationId
          request.staffId: rest.request.staffId
          request.startDate: rest.request.startDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/bookableitems
      name: v1-appointment-bookableitems
      description: REST surface for /v1/appointment/bookableitems.
      operations:
      - method: GET
        name: getBookableItems
        description: Mindbody Returns a List of Availabilities with the Information Needed to Book
        call: public-api-v6-appointment.getBookableItems
        with:
          version: rest.version
          request.sessionTypeIds: rest.request.sessionTypeIds
          siteId: rest.siteId
          authorization: rest.authorization
          request.appointmentId: rest.request.appointmentId
          request.endDate: rest.request.endDate
          request.ignoreDefaultSessionLength: rest.request.ignoreDefaultSessionLength
          request.includeResourceAvailability: rest.request.includeResourceAvailability
          request.limit: rest.request.limit
          request.locationIds: rest.request.locationIds
          request.offset: rest.request.offset
          request.staffIds: rest.request.staffIds
          request.startDate: rest.request.startDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/scheduleitems
      name: v1-appointment-scheduleitems
      description: REST surface for /v1/appointment/scheduleitems.
      operations:
      - method: GET
        name: getScheduleItems
        description: Mindbody Returns a List of Schedule Items, Including Appointments,
        call: public-api-v6-appointment.getScheduleItems
        with:
          version: rest.version
          siteId: rest.siteId
          authorization: rest.authorization
          request.endDate: rest.request.endDate
          request.ignorePrepFinishTimes: rest.request.ignorePrepFinishTimes
          request.limit: rest.request.limit
          request.locationIds: rest.request.locationIds
          request.offset: rest.request.offset
          request.staffIds: rest.request.staffIds
          request.startDate: rest.request.startDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/staffappointments
      name: v1-appointment-staffappointments
      description: REST surface for /v1/appointment/staffappointments.
      operations:
      - method: GET
        name: getStaffAppointments
        description: Mindbody Returns a List of Appointments by Staff Member
        call: public-api-v6-appointment.getStaffAppointments
        with:
          version: rest.version
          siteId: rest.siteId
          authorization: rest.authorization
          request.appointmentIds: rest.request.appointmentIds
          request.clientId: rest.request.clientId
          request.endDate: rest.request.endDate
          request.limit: rest.request.limit
          request.locationIds: rest.request.locationIds
          request.offset: rest.request.offset
          request.staffIds: rest.request.staffIds
          request.startDate: rest.request.startDate
          request.useSiteSettingsStaffName: rest.request.useSiteSettingsStaffName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/unavailabilities
      name: v1-appointment-unavailabilities
      description: REST surface for /v1/appointment/unavailabilities.
      operations:
      - method: GET
        name: getUnavailabilities
        description: Mindbody Returns a List of Unavailabilities. Unavailabilities Are the Times at
        call: public-api-v6-appointment.getUnavailabilities
        with:
          version: rest.version
          siteId: rest.siteId
          authorization: rest.authorization
          request.endDate: rest.request.endDate
          request.limit: rest.request.limit
          request.offset: rest.request.offset
          request.staffIds: rest.request.staffIds
          request.startDate: rest.request.startDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/appointment/addappointment
      name: v1-appointment-addappointment
      description: REST surface for /v1/appointment/addappointment.
      operations:
      - method: POST
     

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/capabilities/public-api-v6-appointment.yaml