Mindbody · Schema

Location

Implementation of the 'Location' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
AdditionalImageURLs	array	A list of URLs of any images associated with this location.
Address	string	The first line of the location’s street address.
Address2	string	A second address line for the location’s street address, if needed.
Amenities	array	A list of strings representing amenities available at the location.
BusinessDescription	string	The business description for the location, as configured by the business owner.
City	string	The location’s city.
Description	string	A description of the location.
HasClasses	boolean	When `true`, indicates that classes are held at this location. When `false`, Indicates that classes are not held at this location.
Id	integer	The ID assigned to this location.
Latitude	number	The location’s latitude.
Longitude	number	The location’s longitude.
Name	string	The name of this location.
Phone	string	The location’s phone number.
PhoneExtension	string	The location’s phone extension.
PostalCode	string	The location’s postal code.
SiteID	integer	The ID number assigned to this location.
StateProvCode	string	The location’s state or province code.
Tax1	number	A decimal representation of the location’s first tax rate. Tax properties are provided to apply all taxes to the purchase price that the purchase is subject to. Use as many tax properties as needed to
Tax2	number	A decimal representation of the location’s second tax rate. See the example in the description of Tax1.
Tax3	number	A decimal representation of the location’s third tax rate. See the example in the description of Tax1.
Tax4	number	A decimal representation of the location’s fourth tax rate. See the example in the description of Tax1.
Tax5	number	A decimal representation of the location’s fifth tax rate. See the example in the description of Tax1.
TotalNumberOfRatings	integer	The number of reviews that clients have left for this location.
AverageRating	number	The average rating for the location, out of five stars.
TotalNumberOfDeals	integer	The number of distinct introductory pricing options available for purchase at this location.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-location-schema.json",
  "title": "Location",
  "description": "Implementation of the 'Location' model.",
  "type": "object",
  "properties": {
    "AdditionalImageURLs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of URLs of any images associated with this location.",
      "example": [
        "example-value"
      ]
    },
    "Address": {
      "type": "string",
      "description": "The first line of the location\u2019s street address.",
      "example": "123 Market St"
    },
    "Address2": {
      "type": "string",
      "description": "A second address line for the location\u2019s street address, if needed.",
      "example": "123 Market St"
    },
    "Amenities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Amenity"
      },
      "description": "A list of strings representing amenities available at the location.",
      "example": [
        {}
      ]
    },
    "BusinessDescription": {
      "type": "string",
      "description": "The business description for the location, as configured by the business owner.",
      "example": "Example note for Mindbody Public API."
    },
    "City": {
      "type": "string",
      "description": "The location\u2019s city.",
      "example": "San Francisco"
    },
    "Description": {
      "type": "string",
      "description": "A description of the location.",
      "example": "Example note for Mindbody Public API."
    },
    "HasClasses": {
      "type": "boolean",
      "description": "When `true`, indicates that classes are held at this location.<br /> When `false`, Indicates that classes are not held at this location.",
      "example": true
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The ID assigned to this location.",
      "example": 123456
    },
    "Latitude": {
      "type": "number",
      "format": "double",
      "description": "The location\u2019s latitude.",
      "example": 1.0
    },
    "Longitude": {
      "type": "number",
      "format": "double",
      "description": "The location\u2019s longitude.",
      "example": 1.0
    },
    "Name": {
      "type": "string",
      "description": "The name of this location.",
      "example": "Sunset Yoga Studio"
    },
    "Phone": {
      "type": "string",
      "description": "The location\u2019s phone number.",
      "example": "+15551234567"
    },
    "PhoneExtension": {
      "type": "string",
      "description": "The location\u2019s phone extension.",
      "example": "example-value"
    },
    "PostalCode": {
      "type": "string",
      "description": "The location\u2019s postal code.",
      "example": "94110"
    },
    "SiteID": {
      "type": "integer",
      "format": "int32",
      "description": "The ID number assigned to this location.",
      "example": 1
    },
    "StateProvCode": {
      "type": "string",
      "description": "The location\u2019s state or province code.",
      "example": "example-value"
    },
    "Tax1": {
      "type": "number",
      "format": "double",
      "description": "A decimal representation of the location\u2019s first tax rate. Tax properties are provided to apply all taxes to the purchase price that the purchase is subject to. Use as many tax properties as needed to represent all the taxes that apply in the location. Enter a decimal number that represents the appropriate tax rate. For example, for an 8% sales tax, enter 0.08.",
      "example": 1.0
    },
    "Tax2": {
      "type": "number",
      "format": "double",
      "description": "A decimal representation of the location\u2019s second tax rate. See the example in the description of Tax1.",
      "example": 1.0
    },
    "Tax3": {
      "type": "number",
      "format": "double",
      "description": "A decimal representation of the location\u2019s third tax rate. See the example in the description of Tax1.",
      "example": 1.0
    },
    "Tax4": {
      "type": "number",
      "format": "double",
      "description": "A decimal representation of the location\u2019s fourth tax rate. See the example in the description of Tax1.",
      "example": 1.0
    },
    "Tax5": {
      "type": "number",
      "format": "double",
      "description": "A decimal representation of the location\u2019s fifth tax rate. See the example in the description of Tax1.",
      "example": 1.0
    },
    "TotalNumberOfRatings": {
      "type": "integer",
      "format": "int32",
      "description": "The number of reviews that clients have left for this location.",
      "example": 1
    },
    "AverageRating": {
      "type": "number",
      "format": "double",
      "description": "The average rating for the location, out of five stars.",
      "example": 1.0
    },
    "TotalNumberOfDeals": {
      "type": "integer",
      "format": "int32",
      "description": "The number of distinct introductory pricing options available for purchase at this location.",
      "example": 1
    }
  }
}