{
"opencollection": "1.0.0",
"info": {
"name": "Mindbody Public API v6 Appointment Site API",
"version": "6.0"
},
"request": {
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Site",
"type": "folder"
},
"items": [
{
"info": {
"name": "Mindbody Before You Can Use This Endpoint, MINDBODY Must Approve Your Developer",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/activationcode",
"headers": [
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Before you can use this endpoint, MINDBODY must approve your developer account for live access. If you have finished testing in the sandbox and are ready to begin working with MINDBODY customers, log into your account and request to go live. See [Accessing Business Data From MINDBODY](https://developers.mindbodyonline.com/PublicDocumentation/V6# accessing-business-data) for more information about the activation code and how to use it. Once you are approved, this endpoint returns an activation co"
},
{
"info": {
"name": "Mindbody Gets the Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/categories",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.active",
"value": "true",
"type": "query",
"description": "When `true`, the response only contains categories which are activated. When `false`, only deactivated categories are returned. Default: **All Categories**"
},
{
"name": "request.categoryIds",
"value": "1",
"type": "query",
"description": "When included, the response only contains details about the specified category Ids."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.service",
"value": "true",
"type": "query",
"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",
"value": "1",
"type": "query",
"description": "When included, the response only contains details about the specified subcategory Ids."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Gets the categories."
},
{
"info": {
"name": "Mindbody The Endpoint Returns a List of Configured Client Gender Options for a",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/genders",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "The endpoint returns a list of configured client gender options for a site. Custom gender options are assignable to client genders only. Currently, custom values returned from this endpoint cannot be used as input for other endpoints to specify the genders of staff or client preferences."
},
{
"info": {
"name": "Mindbody Gets Liability Waiver Content at the Specified Business",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/liabilitywaiver",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Gets Liability Waiver content at the specified business. This endpoint requires staff user credentials."
},
{
"info": {
"name": "Mindbody Get Locations for a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/locations",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get locations for a site."
},
{
"info": {
"name": "Mindbody Get the Memberships at a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/memberships",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.membershipIds",
"value": "1",
"type": "query",
"description": "The requested membership IDs.
Default: **all** IDs that the authenticated user’s access level allows."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get the memberships at a site."
},
{
"info": {
"name": "Mindbody Get the List of Mobile Providers That Are Supported by the Business",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/mobileproviders",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.active",
"value": "true",
"type": "query",
"description": "When `true`, the response only contains mobile providers which are activated. When `false`, only deactivated mobile providers are returned. Default: **All Mobile Providers**"
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get the list of mobile providers that are supported by the business."
},
{
"info": {
"name": "Mindbody Get Payment Types for a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/paymenttypes",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.active",
"value": "true",
"type": "query",
"description": "When `true`, the response only contains payment types which are activated. When `false`, only deactivated payment types are returned. Default: **All Payment Types**"
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get payment types for a site."
},
{
"info": {
"name": "Mindbody Get Service Categories Offered at a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/programs",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.onlineOnly",
"value": "true",
"type": "query",
"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",
"value": "1",
"type": "query",
"description": "Program Ids to filter for"
},
{
"name": "request.scheduleType",
"value": "[object Object]",
"type": "query",
"description": "A schedule type used to filter the returned results. Possible values are: * All * Class * Enrollment * Appointment * Resource * Media * Arrival"
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get service categories offered at a site."
},
{
"info": {
"name": "Mindbody Gets a List of Promocodes at the Specified Business. This Endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/promocodes",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.activeOnly",
"value": "true",
"type": "query",
"description": "If true, filters results to show only promocodes that are active. If **false**, all promocodes are returned. Default: **true**"
},
{
"name": "request.endDate",
"value": "2026-05-28T14:30:00Z",
"type": "query",
"description": "Filters results to promocodes that were activated before this date."
},
{
"name": "request.lastModifiedDate",
"value": "2026-05-28T14:30:00Z",
"type": "query",
"description": "Filters results to promocodes that were modified on or after this date."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.onlineOnly",
"value": "true",
"type": "query",
"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",
"value": "2026-05-28T14:30:00Z",
"type": "query",
"description": "Filters results to promocodes that were activated after this date."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Gets a list of promocodes at the specified business. This endpoint requires staff user credentials. This staff member should have enabled the Set up promotions / **Semester discounts** staff permission."
},
{
"info": {
"name": "Mindbody Get the List of Prospect Stages That Represent the Prospect Stage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/prospectstages",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.active",
"value": "true",
"type": "query",
"description": "When `true`, the response only contains prospect stages which are activated. When `false`, only deactivated prospect stages are returned. Default: **All Prospect Stages**"
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get the list of prospect stages that represent the prospect stage options for prospective clients."
},
{
"info": {
"name": "Mindbody This Endpoint Retrieves the Business Site Relationships",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/relationships",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.active",
"value": "true",
"type": "query",
"description": "When `true`, the response only contains relationships which are activated. When `false`, only deactivated relationships are returned. Default: **All Relationships**"
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "This endpoint retrieves the business site relationships."
},
{
"info": {
"name": "Mindbody Get Resource Availabilities Used at a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/resourceavailabilities",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.endDate",
"value": "2026-05-28T14:30:00Z",
"type": "query",
"description": "End date. If default, StartDate is used."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.locationIds",
"value": "1",
"type": "query",
"description": "Filter by location ids (optional)"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.programIds",
"value": "1",
"type": "query",
"description": "Filter by program ids (optional)"
},
{
"name": "request.resourceIds",
"value": "1",
"type": "query",
"description": "Filter on resourceIds"
},
{
"name": "request.scheduleTypes",
"value": "[object Object]",
"type": "query",
"description": "Filter by schedule types (optional)"
},
{
"name": "request.startDate",
"value": "2026-05-28T14:30:00Z",
"type": "query",
"description": "Start time"
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get resource availabilities used at a site."
},
{
"info": {
"name": "Mindbody Get Resources Used at a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/resources",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.includeInactive",
"value": "true",
"type": "query",
"description": "Enable to include inactive"
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.locationIds",
"value": "1",
"type": "query",
"description": "Filter by location ids (optional)"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.programIds",
"value": "1",
"type": "query",
"description": "Filter by program ids (optional)"
},
{
"name": "request.resourceIds",
"value": "1",
"type": "query",
"description": "Filter on resourceIds"
},
{
"name": "request.scheduleTypes",
"value": "[object Object]",
"type": "query",
"description": "Filter by schedule types (optional)"
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get resources used at a site."
},
{
"info": {
"name": "Mindbody Get the Session Types Used at a Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/sessiontypes",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.onlineOnly",
"value": "true",
"type": "query",
"description": "When `true`, indicates that only the session types that can be booked online should be returned.
Default: **false**"
},
{
"name": "request.programIDs",
"value": "1",
"type": "query",
"description": "Filters results to session types that belong to one of the given program IDs. If omitted, all program IDs return."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Get the session types used at a site."
},
{
"info": {
"name": "Mindbody Gets a List of Sites That the Developer Has Permission to View",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mindbodyonline.com/public/v6/site/sites",
"headers": [
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
},
{
"name": "request.includeLeadChannels",
"value": "true",
"type": "query",
"description": "This is an optional parameter to get lead channels for a Site."
},
{
"name": "request.includePerStaffPricing",
"value": "true",
"type": "query",
"description": "Include whether or not studios have per staff pricing enabled."
},
{
"name": "request.limit",
"value": "1",
"type": "query",
"description": "Number of results to include, defaults to 100"
},
{
"name": "request.offset",
"value": "1",
"type": "query",
"description": "Page offset, defaults to 0."
},
{
"name": "request.siteIds",
"value": "1",
"type": "query",
"description": "List of the requested site IDs. When omitted, returns all sites that the source has access to."
}
],
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Gets a list of sites that the developer has permission to view. * Passing in no `SiteIds` returns all sites that the developer has access to. * Passing in one `SiteIds` returns more detailed information about the specified site. Important Behavior Notice: When calling GetSites without specifying a SiteId, or when passing multiple SiteIds, the response will include only limited data for each site. This is expected behavior designed to help identify accessible sites without returning full site-lev"
},
{
"info": {
"name": "Mindbody Creates a New Client Index Record at the Specified Business",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mindbodyonline.com/public/v6/site/addclientindex",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Creates a new client index record at the specified business. This endpoint requires staff user credentials."
},
{
"info": {
"name": "Mindbody Creates a New Promocode Record at the Specified Business",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mindbodyonline.com/public/v6/site/addpromocode",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Creates a new promocode record at the specified business. This endpoint requires staff user credentials. This staff memeber should have enabled the **Set up promotions / Semester discounts** staff permission."
},
{
"info": {
"name": "Mindbody Deactivates an Existing Promocode Record at the Specified Business",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mindbodyonline.com/public/v6/site/deactivatepromocode",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Deactivates an existing promocode record at the specified business. This endpoint requires staff user credentials. This staff memeber should have enabled the **Set up promotions / Semester discounts** staff permission."
},
{
"info": {
"name": "Mindbody Updates an Exisitng Client Index Record at the Specified Business",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mindbodyonline.com/public/v6/site/updateclientindex",
"headers": [
{
"name": "siteId",
"value": "example-value"
},
{
"name": "authorization",
"value": "example-value"
}
],
"params": [
{
"name": "version",
"value": "example-value",
"type": "path",
"description": "version of the api."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "API-Key",
"value": "{{API-Key}}",
"placement": "header"
}
},
"docs": "Updates an exisitng client index record at the specified business. This endpoint requires staff user credentials."
}
]
}
],
"bundled": true
}