naftiko: 1.0.0-alpha2
info:
label: "Mindbody Public API v6 \u2014 Site"
description: "Site \u2014 20 operations. Lead operation: Mindbody Before You Can Use This Endpoint, MINDBODY Must Approve Your Developer. Self-contained Naftiko capability covering one Mindbody business\
\ surface."
tags:
- Mindbody
- Mindbody Public API v6
- Site
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-site
baseUri: https://api.mindbodyonline.com
description: "Mindbody Public API v6 \u2014 Site business capability. Self-contained, no shared references."
authentication:
type: apikey
key: API-Key
value: '{{env.MINDBODY_API_KEY}}'
placement: header
resources:
- name: site-activationcode
path: /site/activationcode
operations:
- name: getActivationCode
method: GET
description: Mindbody Before You Can Use This Endpoint, MINDBODY Must Approve Your Developer
inputParameters:
- name: version
in: path
type: string
required: true
description: version of the api.
- name: authorization
in: header
type: string
required: false
description: A staff user authorization token.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-categories
path: /site/categories
operations:
- name: getCategories
method: GET
description: Mindbody Gets the Categories
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.active
in: query
type: boolean
required: false
description: 'When `true`, the response only contains categories which are activated. When `false`, only deactivated categories are returned. Default: **All Categories**'
- name: request.categoryIds
in: query
type: array
required: false
description: When included, the response only contains details about the specified category Ids.
- 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.service
in: query
type: boolean
required: false
description: 'When `true`, the response only contains details about Revenue Categories. When `false`, only Product Revenue Categories are returned. Default: **All Categories**'
- name: request.subCategoryIds
in: query
type: array
required: false
description: When included, the response only contains details about the specified subcategory Ids.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-genders
path: /site/genders
operations:
- name: getGenders
method: GET
description: Mindbody The Endpoint Returns a List of Configured Client Gender Options for 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.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-liabilitywaiver
path: /site/liabilitywaiver
operations:
- name: getLiabilityWaiver
method: GET
description: Mindbody Gets Liability Waiver Content at the Specified 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.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-locations
path: /site/locations
operations:
- name: getLocations
method: GET
description: Mindbody Get Locations for a Site
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.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-memberships
path: /site/memberships
operations:
- name: getMemberships
method: GET
description: Mindbody Get the Memberships at a Site
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.membershipIds
in: query
type: array
required: false
description: "The requested membership IDs.
Default: **all** IDs that the authenticated user\u2019s access level allows."
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-mobileproviders
path: /site/mobileproviders
operations:
- name: getMobileProviders
method: GET
description: Mindbody Get the List of Mobile Providers That Are Supported by the 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.active
in: query
type: boolean
required: false
description: 'When `true`, the response only contains mobile providers which are activated. When `false`, only deactivated mobile providers are returned. Default: **All Mobile Providers**'
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-paymenttypes
path: /site/paymenttypes
operations:
- name: getPaymentTypes
method: GET
description: Mindbody Get Payment Types for a Site
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.active
in: query
type: boolean
required: false
description: 'When `true`, the response only contains payment types which are activated. When `false`, only deactivated payment types are returned. Default: **All Payment Types**'
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-programs
path: /site/programs
operations:
- name: getPrograms
method: GET
description: Mindbody Get Service Categories Offered at a Site
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.onlineOnly
in: query
type: boolean
required: false
description: 'If `true`, filters results to show only those programs that are shown online.
If `false`, all programs are returned.
Default: **false**'
- name: request.programIds
in: query
type: array
required: false
description: Program Ids to filter for
- name: request.scheduleType
in: query
type: string
required: false
description: 'A schedule type used to filter the returned results. Possible values are: * All * Class * Enrollment * Appointment * Resource * Media * Arrival'
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-promocodes
path: /site/promocodes
operations:
- name: getPromoCodes
method: GET
description: Mindbody Gets a List of Promocodes at the Specified Business. This Endpoint
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.activeOnly
in: query
type: boolean
required: false
description: 'If true, filters results to show only promocodes that are active. If **false**, all promocodes are returned. Default: **true**'
- name: request.endDate
in: query
type: string
required: false
description: Filters results to promocodes that were activated before this date.
- name: request.lastModifiedDate
in: query
type: string
required: false
description: Filters results to promocodes that were modified on or after this 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.onlineOnly
in: query
type: boolean
required: false
description: 'If `true`, filters results to show only promocodes that can be used for online sale. If `false`, all promocodes are returned. Default: **false**'
- name: request.startDate
in: query
type: string
required: false
description: Filters results to promocodes that were activated after this date.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-prospectstages
path: /site/prospectstages
operations:
- name: getProspectStages
method: GET
description: Mindbody Get the List of Prospect Stages That Represent the Prospect Stage
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.active
in: query
type: boolean
required: false
description: 'When `true`, the response only contains prospect stages which are activated. When `false`, only deactivated prospect stages are returned. Default: **All Prospect Stages**'
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-relationships
path: /site/relationships
operations:
- name: getRelationships
method: GET
description: Mindbody This Endpoint Retrieves the Business Site Relationships
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.active
in: query
type: boolean
required: false
description: 'When `true`, the response only contains relationships which are activated. When `false`, only deactivated relationships are returned. Default: **All Relationships**'
- 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.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-resourceavailabilities
path: /site/resourceavailabilities
operations:
- name: getResourceAvailabilities
method: GET
description: Mindbody Get Resource Availabilities Used at a Site
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: End date. If default, StartDate is used.
- 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: Filter by location ids (optional)
- name: request.offset
in: query
type: integer
required: false
description: Page offset, defaults to 0.
- name: request.programIds
in: query
type: array
required: false
description: Filter by program ids (optional)
- name: request.resourceIds
in: query
type: array
required: false
description: Filter on resourceIds
- name: request.scheduleTypes
in: query
type: array
required: false
description: Filter by schedule types (optional)
- name: request.startDate
in: query
type: string
required: false
description: Start time
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-resources
path: /site/resources
operations:
- name: getResources
method: GET
description: Mindbody Get Resources Used at a Site
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.includeInactive
in: query
type: boolean
required: false
description: Enable to include inactive
- 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: Filter by location ids (optional)
- name: request.offset
in: query
type: integer
required: false
description: Page offset, defaults to 0.
- name: request.programIds
in: query
type: array
required: false
description: Filter by program ids (optional)
- name: request.resourceIds
in: query
type: array
required: false
description: Filter on resourceIds
- name: request.scheduleTypes
in: query
type: array
required: false
description: Filter by schedule types (optional)
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-sessiontypes
path: /site/sessiontypes
operations:
- name: getSessionTypes
method: GET
description: Mindbody Get the Session Types Used at a Site
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.onlineOnly
in: query
type: boolean
required: false
description: 'When `true`, indicates that only the session types that can be booked online should be returned.
Default: **false**'
- name: request.programIDs
in: query
type: array
required: false
description: Filters results to session types that belong to one of the given program IDs. If omitted, all program IDs return.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-sites
path: /site/sites
operations:
- name: getSites
method: GET
description: Mindbody Gets a List of Sites That the Developer Has Permission to View
inputParameters:
- name: version
in: path
type: string
required: true
description: version of the api.
- name: authorization
in: header
type: string
required: false
description: A staff user authorization token.
- name: request.includeLeadChannels
in: query
type: boolean
required: false
description: This is an optional parameter to get lead channels for a Site.
- name: request.includePerStaffPricing
in: query
type: boolean
required: false
description: Include whether or not studios have per staff pricing enabled.
- 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.siteIds
in: query
type: array
required: false
description: List of the requested site IDs. When omitted, returns all sites that the source has access to.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-addclientindex
path: /site/addclientindex
operations:
- name: addClientIndex
method: POST
description: Mindbody Creates a New Client Index Record at the Specified 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: body
in: body
type: object
required: true
description: JSON request body.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-addpromocode
path: /site/addpromocode
operations:
- name: addPromoCode
method: POST
description: Mindbody Creates a New Promocode Record at the Specified 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: body
in: body
type: object
required: true
description: JSON request body.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-deactivatepromocode
path: /site/deactivatepromocode
operations:
- name: deactivatePromoCode
method: POST
description: Mindbody Deactivates an Existing Promocode Record at the Specified 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: body
in: body
type: object
required: true
description: JSON request body.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: site-updateclientindex
path: /site/updateclientindex
operations:
- name: updateClientIndex
method: POST
description: Mindbody Updates an Exisitng Client Index Record at the Specified 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: body
in: body
type: object
required: true
description: JSON request body.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
exposes:
- type: rest
namespace: public-api-v6-site-rest
port: 8080
description: "REST adapter for Mindbody Public API v6 \u2014 Site. One Spectral-compliant resource per consumed operation, prefixed with /v1."
resources:
- path: /v1/site/activationcode
name: v1-site-activationcode
description: REST surface for /v1/site/activationcode.
operations:
- method: GET
name: getActivationCode
description: Mindbody Before You Can Use This Endpoint, MINDBODY Must Approve Your Developer
call: public-api-v6-site.getActivationCode
with:
version: rest.version
authorization: rest.authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/site/categories
name: v1-site-categories
description: REST surface for /v1/site/categories.
operations:
- method: GET
name: getCategories
description: Mindbody Gets the Categories
call: public-api-v6-site.getCategories
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.active: rest.request.active
request.categoryIds: rest.request.categoryIds
request.limit: rest.request.limit
request.offset: rest.request.offset
request.service: rest.request.service
request.subCategoryIds: rest.request.subCategoryIds
outputParameters:
- type: object
mapping: $.
- path: /v1/site/genders
name: v1-site-genders
description: REST surface for /v1/site/genders.
operations:
- method: GET
name: getGenders
description: Mindbody The Endpoint Returns a List of Configured Client Gender Options for a
call: public-api-v6-site.getGenders
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/site/liabilitywaiver
name: v1-site-liabilitywaiver
description: REST surface for /v1/site/liabilitywaiver.
operations:
- method: GET
name: getLiabilityWaiver
description: Mindbody Gets Liability Waiver Content at the Specified Business
call: public-api-v6-site.getLiabilityWaiver
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/site/locations
name: v1-site-locations
description: REST surface for /v1/site/locations.
operations:
- method: GET
name: getLocations
description: Mindbody Get Locations for a Site
call: public-api-v6-site.getLocations
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.limit: rest.request.limit
request.offset: rest.request.offset
outputParameters:
- type: object
mapping: $.
- path: /v1/site/memberships
name: v1-site-memberships
description: REST surface for /v1/site/memberships.
operations:
- method: GET
name: getMemberships
description: Mindbody Get the Memberships at a Site
call: public-api-v6-site.getMemberships
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.membershipIds: rest.request.membershipIds
outputParameters:
- type: object
mapping: $.
- path: /v1/site/mobileproviders
name: v1-site-mobileproviders
description: REST surface for /v1/site/mobileproviders.
operations:
- method: GET
name: getMobileProviders
description: Mindbody Get the List of Mobile Providers That Are Supported by the Business
call: public-api-v6-site.getMobileProviders
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.active: rest.request.active
outputParameters:
- type: object
mapping: $.
- path: /v1/site/paymenttypes
name: v1-site-paymenttypes
description: REST surface for /v1/site/paymenttypes.
operations:
- method: GET
name: getPaymentTypes
description: Mindbody Get Payment Types for a Site
call: public-api-v6-site.getPaymentTypes
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.active: rest.request.active
outputParameters:
- type: object
mapping: $.
- path: /v1/site/programs
name: v1-site-programs
description: REST surface for /v1/site/programs.
operations:
- method: GET
name: getPrograms
description: Mindbody Get Service Categories Offered at a Site
call: public-api-v6-site.getPrograms
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.limit: rest.request.limit
request.offset: rest.request.offset
request.onlineOnly: rest.request.onlineOnly
request.programIds: rest.request.programIds
request.scheduleType: rest.request.scheduleType
outputParameters:
- type: object
mapping: $.
- path: /v1/site/promocodes
name: v1-site-promocodes
description: REST surface for /v1/site/promocodes.
operations:
- method: GET
name: getPromoCodes
description: Mindbody Gets a List of Promocodes at the Specified Business. This Endpoint
call: public-api-v6-site.getPromoCodes
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.activeOnly: rest.request.activeOnly
request.endDate: rest.request.endDate
request.lastModifiedDate: rest.request.lastModifiedDate
request.limit: rest.request.limit
request.offset: rest.request.offset
request.onlineOnly: rest.request.onlineOnly
request.startDate: rest.request.startDate
outputParameters:
- type: object
mapping: $.
- path: /v1/site/prospectstages
name: v1-site-prospectstages
description: REST surface for /v1/site/prospectstages.
operations:
- method: GET
name: getProspectStages
description: Mindbody Get the List of Prospect Stages That Represent the Prospect Stage
call: public-api-v6-site.getProspectStages
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.active: rest.request.active
outputParameters:
- type: object
mapping: $.
- path: /v1/site/relationships
name: v1-site-relationships
description: REST surface for /v1/site/relationships.
operations:
- method: GET
name: getRelationships
description: Mindbody This Endpoint Retrieves the Business Site Relationships
call: public-api-v6-site.getRelationships
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.active: rest.request.active
request.limit: rest.request.limit
request.offset: rest.request.offset
outputParameters:
- type: object
mapping: $.
- path: /v1/site/resourceavailabilities
name: v1-site-resourceavailabilities
description: REST surface for /v1/site/resourceavailabilities.
operations:
- method: GET
name: getResourceAvailabilities
description: Mindbody Get Resource Availabilities Used at a Site
call: public-api-v6-site.getResourceAvailabilities
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.endDate: rest.request.endDate
request.limit: rest.request.limit
request.locationIds: rest.request.locationIds
request.offset: rest.request.offset
request.programIds: rest.request.programIds
request.resourceIds: rest.request.resourceIds
request.scheduleTypes: rest.request.scheduleTypes
request.startDate: rest.request.startDate
outputParameters:
- type: object
mapping: $.
- path: /v1/site/resources
name: v1-site-resources
description: REST surface for /v1/site/resources.
operations:
- method: GET
name: getResources
description: Mindbody Get Resources Used at a Site
call: public-api-v6-site.getResources
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.includeInactive: rest.request.includeInactive
request.limit: rest.request.limit
request.locationIds: rest.request.locationIds
request.offset: rest.request.offset
request.programIds: rest.request.programIds
request.resourceIds: rest.request.resourceIds
request.scheduleTypes: rest.request.scheduleTypes
outputParameters:
- type: object
mapping: $.
- path: /v1/site/sessiontypes
name: v1-site-sessiontypes
description: REST surface for /v1/site/sessiontypes.
operations:
- method: GET
name: getSessionTypes
description: Mindbody Get the Session Types Used at a Site
call: public-api-v6-site.getSessionTypes
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
request.limit: rest.request.limit
request.offset: rest.request.offset
request.onlineOnly: rest.request.onlineOnly
request.programIDs: rest.request.programIDs
outputParameters:
- type: object
mapping: $.
- path: /v1/site/sites
name: v1-site-sites
description: REST surface for /v1/site/sites.
operations:
- method: GET
name: getSites
description: Mindbody Gets a List of Sites That the Developer Has Permission to View
call: public-api-v6-site.getSites
with:
version: rest.version
authorization: rest.authorization
request.includeLeadChannels: rest.request.includeLeadChannels
request.includePerStaffPricing: rest.request.includePerStaffPricing
request.limit: rest.request.limit
request.offset: rest.request.offset
request.siteIds: rest.request.siteIds
outputParameters:
- type: object
mapping: $.
- path: /v1/site/addclientindex
name: v1-site-addclientindex
description: REST surface for /v1/site/addclientindex.
operations:
- method: POST
name: addClientIndex
description: Mindbody Creates a New Client Index Record at the Specified Business
call: public-api-v6-site.addClientIndex
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/site/addpromocode
name: v1-site-addpromocode
description: REST surface for /v1/site/addpromocode.
operations:
- method: POST
name: addPromoCode
description: Mindbody Creates a New Promocode Record at the Specified Business
call: public-api-v6-site.addPromoCode
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/site/deactivatepromocode
name: v1-site-deactivatepromocode
description: REST surface for /v1/site/deactivatepromocode.
operations:
- method: POST
name: deactivatePromoCode
description: Mindbody Deactivates an Existing Promocode Record at the Specified Business
call: public-api-v6-site.deactivatePromoCode
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/site/updateclientindex
name: v1-site-updateclientindex
description: REST surface for /v1/site/updateclientindex.
operations:
- method: POST
name: updateClientIndex
description: Mindbody Updates an Exisitng Client Index Record at the Specified Business
call: public-api-v6-site.updateClientIndex
with:
version: rest.version
siteId: rest.siteId
authorization: rest.authorization
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: public-api-v6-site-mcp
port: 9090
transport: http
description: "MCP adapter for Mindbody Public API v6 \u2014 Site. One tool per consumed operation, routed inline through this capability's consumes block."
tools:
- name: before-you-can-use-this
description: Mindbody Before You Can Use This Endpoint, MINDBODY Must Approve Your Developer
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getActivationCode
with:
version: tools.version
authorization: tools.authorization
outputParameters:
- type: object
mapping: $.
- name: gets-categories
description: Mindbody Gets the Categories
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getCategories
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.active: tools.request.active
request.categoryIds: tools.request.categoryIds
request.limit: tools.request.limit
request.offset: tools.request.offset
request.service: tools.request.service
request.subCategoryIds: tools.request.subCategoryIds
outputParameters:
- type: object
mapping: $.
- name: endpoint-returns-list-configured-client
description: Mindbody The Endpoint Returns a List of Configured Client Gender Options for a
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getGenders
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
outputParameters:
- type: object
mapping: $.
- name: gets-liability-waiver-content-specified
description: Mindbody Gets Liability Waiver Content at the Specified Business
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getLiabilityWaiver
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
outputParameters:
- type: object
mapping: $.
- name: get-locations-site
description: Mindbody Get Locations for a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getLocations
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.limit: tools.request.limit
request.offset: tools.request.offset
outputParameters:
- type: object
mapping: $.
- name: get-memberships-site
description: Mindbody Get the Memberships at a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getMemberships
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.membershipIds: tools.request.membershipIds
outputParameters:
- type: object
mapping: $.
- name: get-list-mobile-providers-that
description: Mindbody Get the List of Mobile Providers That Are Supported by the Business
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getMobileProviders
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.active: tools.request.active
outputParameters:
- type: object
mapping: $.
- name: get-payment-types-site
description: Mindbody Get Payment Types for a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getPaymentTypes
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.active: tools.request.active
outputParameters:
- type: object
mapping: $.
- name: get-service-categories-offered-site
description: Mindbody Get Service Categories Offered at a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getPrograms
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.limit: tools.request.limit
request.offset: tools.request.offset
request.onlineOnly: tools.request.onlineOnly
request.programIds: tools.request.programIds
request.scheduleType: tools.request.scheduleType
outputParameters:
- type: object
mapping: $.
- name: gets-list-promocodes-specified-business.
description: Mindbody Gets a List of Promocodes at the Specified Business. This Endpoint
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getPromoCodes
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.activeOnly: tools.request.activeOnly
request.endDate: tools.request.endDate
request.lastModifiedDate: tools.request.lastModifiedDate
request.limit: tools.request.limit
request.offset: tools.request.offset
request.onlineOnly: tools.request.onlineOnly
request.startDate: tools.request.startDate
outputParameters:
- type: object
mapping: $.
- name: get-list-prospect-stages-that
description: Mindbody Get the List of Prospect Stages That Represent the Prospect Stage
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getProspectStages
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.active: tools.request.active
outputParameters:
- type: object
mapping: $.
- name: this-endpoint-retrieves-business-site
description: Mindbody This Endpoint Retrieves the Business Site Relationships
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getRelationships
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.active: tools.request.active
request.limit: tools.request.limit
request.offset: tools.request.offset
outputParameters:
- type: object
mapping: $.
- name: get-resource-availabilities-used-site
description: Mindbody Get Resource Availabilities Used at a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getResourceAvailabilities
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.endDate: tools.request.endDate
request.limit: tools.request.limit
request.locationIds: tools.request.locationIds
request.offset: tools.request.offset
request.programIds: tools.request.programIds
request.resourceIds: tools.request.resourceIds
request.scheduleTypes: tools.request.scheduleTypes
request.startDate: tools.request.startDate
outputParameters:
- type: object
mapping: $.
- name: get-resources-used-site
description: Mindbody Get Resources Used at a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getResources
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.includeInactive: tools.request.includeInactive
request.limit: tools.request.limit
request.locationIds: tools.request.locationIds
request.offset: tools.request.offset
request.programIds: tools.request.programIds
request.resourceIds: tools.request.resourceIds
request.scheduleTypes: tools.request.scheduleTypes
outputParameters:
- type: object
mapping: $.
- name: get-session-types-used-site
description: Mindbody Get the Session Types Used at a Site
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getSessionTypes
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
request.limit: tools.request.limit
request.offset: tools.request.offset
request.onlineOnly: tools.request.onlineOnly
request.programIDs: tools.request.programIDs
outputParameters:
- type: object
mapping: $.
- name: gets-list-sites-that-developer
description: Mindbody Gets a List of Sites That the Developer Has Permission to View
hints:
readOnly: true
destructive: false
idempotent: true
call: public-api-v6-site.getSites
with:
version: tools.version
authorization: tools.authorization
request.includeLeadChannels: tools.request.includeLeadChannels
request.includePerStaffPricing: tools.request.includePerStaffPricing
request.limit: tools.request.limit
request.offset: tools.request.offset
request.siteIds: tools.request.siteIds
outputParameters:
- type: object
mapping: $.
- name: creates-new-client-index-record
description: Mindbody Creates a New Client Index Record at the Specified Business
hints:
readOnly: false
destructive: false
idempotent: false
call: public-api-v6-site.addClientIndex
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: creates-new-promocode-record-specified
description: Mindbody Creates a New Promocode Record at the Specified Business
hints:
readOnly: false
destructive: false
idempotent: false
call: public-api-v6-site.addPromoCode
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: deactivates-existing-promocode-record-specified
description: Mindbody Deactivates an Existing Promocode Record at the Specified Business
hints:
readOnly: false
destructive: false
idempotent: false
call: public-api-v6-site.deactivatePromoCode
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-exisitng-client-index-record
description: Mindbody Updates an Exisitng Client Index Record at the Specified Business
hints:
readOnly: false
destructive: false
idempotent: false
call: public-api-v6-site.updateClientIndex
with:
version: tools.version
siteId: tools.siteId
authorization: tools.authorization
body: tools.body
outputParameters:
- type: object
mapping: $.