Mindbody · Schema

Site

Implementation of the 'Site' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
AcceptsAmericanExpress boolean When `true`, indicates that this site accepts American Express cards.
When `false`, indicates that this site does not accept American Express credit cards.
AcceptsDiscover boolean When `true`, indicates that this site accepts Discover cards.
When `false`, indicates that this site does not accept Discover credit cards.
AcceptsMasterCard boolean When `true`, indicates that this site accepts MasterCard cards.
When `false`, indicates that this site does not accept MasterCard credit cards.
AcceptsVisa boolean When `true`, indicates that this site accepts Visa cards.
When `false`, indicates that this site does not accept Visa credit cards.
AllowsDashboardAccess boolean When `true`, indicates that this site allows access to its dashboard.
When `false`, indicates that this site does not allow access to its dashboard.
ContactEmail string The site’s email address.
Description string A description of the site.
Id integer The site ID.
LogoUrl string The URL to the site’s logo.
Name string The name of the site.
PageColor1 string A hex code for a color the business owner uses in marketing. This color can be used to set a theme for an integration so that it matches the configured color-scheme for the business.
PageColor2 string The hex code for a second color, to be used in the same manner as `pageColor1`.
PageColor3 string The hex code for a third color, to be used in the same manner as `pageColor1`.
PageColor4 string The hex code for a fourth color, to be used in the same manner as `pageColor1`.
PricingLevel string The MINDBODY pricing level for the business. Possible values are: Accelerate - The business is on MINDBODY’s Accelerate pricing tier. Grow - The business is on MINDBODY’s Essential pricing tier. Legac
SmsPackageEnabled boolean When `true`, indicates that the business uses SMS text messages to communicate with its clients.
When `false`, indicates that the business does not use SMS text messages to communicate with its
TaxInclusivePrices boolean When `true`, indicates that the total includes tax.
When `false`, indicates that the total does not include tax.
CurrencyIsoCode string The currency ISO code for the site.
CountryCode string The country code for the site.
TimeZone string The time zone the site is located in.
AcceptsDirectDebit boolean When `true`, indicates that direct debit can be used by clients at this site.
When `false`, indicates that direct debit can not by used by clients at this site.
LeadChannels array The list of lead channels available for a subscriber/studio.
PerStaffPricing boolean When `true`, indicates that per-staff pricing is enabled at this site.
When `false`, indicates that per-staff pricing is not enabled at this site.
View JSON Schema on GitHub

JSON Schema

public-api-v6-site-schema.json Raw ↑
{
  "$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-site-schema.json",
  "title": "Site",
  "description": "Implementation of the 'Site' model.",
  "type": "object",
  "properties": {
    "AcceptsAmericanExpress": {
      "type": "boolean",
      "description": "When `true`, indicates that this site accepts American Express cards.<br /> When `false`, indicates that this site does not accept American Express credit cards.",
      "example": true
    },
    "AcceptsDiscover": {
      "type": "boolean",
      "description": "When `true`, indicates that this site accepts Discover cards.<br /> When `false`, indicates that this site does not accept Discover credit cards.",
      "example": true
    },
    "AcceptsMasterCard": {
      "type": "boolean",
      "description": "When `true`, indicates that this site accepts MasterCard cards.<br /> When `false`, indicates that this site does not accept MasterCard credit cards.",
      "example": true
    },
    "AcceptsVisa": {
      "type": "boolean",
      "description": "When `true`, indicates that this site accepts Visa cards.<br /> When `false`, indicates that this site does not accept Visa credit cards.",
      "example": true
    },
    "AllowsDashboardAccess": {
      "type": "boolean",
      "description": "When `true`, indicates that this site allows access to its dashboard.<br /> When `false`, indicates that this site does not allow access to its dashboard.",
      "example": true
    },
    "ContactEmail": {
      "type": "string",
      "description": "The site\u2019s email address.",
      "example": "[email protected]"
    },
    "Description": {
      "type": "string",
      "description": "A description of the site.",
      "example": "Example note for Mindbody Public API."
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The site ID.",
      "example": 123456
    },
    "LogoUrl": {
      "type": "string",
      "description": "The URL to the site\u2019s logo.",
      "example": "https://example.mindbodyonline.com/resource/abc123"
    },
    "Name": {
      "type": "string",
      "description": "The name of the site.",
      "example": "Sunset Yoga Studio"
    },
    "PageColor1": {
      "type": "string",
      "description": "A hex code for a color the business owner uses in marketing. This color can be used to set a theme for an integration so that it matches the configured color-scheme for the business.",
      "example": "example-value"
    },
    "PageColor2": {
      "type": "string",
      "description": "The hex code for a second color, to be used in the same manner as `pageColor1`.",
      "example": "example-value"
    },
    "PageColor3": {
      "type": "string",
      "description": "The hex code for a third color, to be used in the same manner as `pageColor1`.",
      "example": "example-value"
    },
    "PageColor4": {
      "type": "string",
      "description": "The hex code for a fourth color, to be used in the same manner as `pageColor1`.",
      "example": "example-value"
    },
    "PricingLevel": {
      "type": "string",
      "description": "The MINDBODY pricing level for the business. Possible values are: Accelerate - The business is on MINDBODY\u2019s Accelerate pricing tier. Grow - The business is on MINDBODY\u2019s Essential pricing tier. Legacy - The business is on an older MINDBODY pricing tier that is no longer offered. Listing - The business is on an older MINDBODY pricing tier that is no longer offered. Pro - The business is on an older MINDBODY pricing tier that is no longer offered. Solo - The business is on an older MINDBODY prici",
      "example": "example-value"
    },
    "SmsPackageEnabled": {
      "type": "boolean",
      "description": "When `true`, indicates that the business uses SMS text messages to communicate with its clients.<br /> When `false`, indicates that the business does not use SMS text messages to communicate with its clients.",
      "example": true
    },
    "TaxInclusivePrices": {
      "type": "boolean",
      "description": "When `true`, indicates that the total includes tax.<br /> When `false`, indicates that the total does not include tax.",
      "example": true
    },
    "CurrencyIsoCode": {
      "type": "string",
      "description": "The currency ISO code for the site.",
      "example": "example-value"
    },
    "CountryCode": {
      "type": "string",
      "description": "The country code for the site.",
      "example": "example-value"
    },
    "TimeZone": {
      "type": "string",
      "description": "The time zone the site is located in.",
      "example": "example-value"
    },
    "AcceptsDirectDebit": {
      "type": "boolean",
      "description": "When `true`, indicates that direct debit can be used by clients at this site.<br /> When `false`, indicates that direct debit can not by used by clients at this site.",
      "example": true
    },
    "LeadChannels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LeadChannel"
      },
      "description": "The list of lead channels available for a subscriber/studio.",
      "example": [
        {}
      ]
    },
    "PerStaffPricing": {
      "type": "boolean",
      "description": "When `true`, indicates that per-staff pricing is enabled at this site.<br /> When `false`, indicates that per-staff pricing is not enabled at this site.",
      "example": true
    }
  }
}