Mindbody · JSON Structure

Public Api V6 Class Description Structure

Implementation of the 'ClassDescription' model. Represents a class definition. The class meets at the start time, goes until the end time.

Type: object Properties: 15

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

ClassDescription is a JSON Structure definition published by Mindbody, describing 15 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Active Description Id ImageURL LastUpdated Level Name Notes Prereq Program SessionType Category CategoryId Subcategory SubcategoryId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-class-description-structure.json",
  "name": "ClassDescription",
  "description": "Implementation of the 'ClassDescription' model. Represents a class definition. The class meets at the start time, goes until the end time.",
  "type": "object",
  "properties": {
    "Active": {
      "type": "boolean",
      "description": "When `true`, indicates that the business can assign this class description to new class schedules.<br /> When `false`, indicates that the business cannot assign this class description to new class schedules.",
      "example": true
    },
    "Description": {
      "type": "string",
      "description": "The long version of the class description.",
      "example": "Example note for Mindbody Public API."
    },
    "Id": {
      "type": "int32",
      "description": "The class description's ID.",
      "example": 123456
    },
    "ImageURL": {
      "type": "string",
      "description": "The class description's image URL, if any. If it does not exist, nothing is returned.",
      "example": "example-value"
    },
    "LastUpdated": {
      "type": "datetime",
      "description": "The date this class description was last modified.",
      "example": "2026-05-28T14:30:00Z"
    },
    "Level": {
      "$ref": "#/components/schemas/Level",
      "description": "The level information about this class."
    },
    "Name": {
      "type": "string",
      "description": "The name of this class description.",
      "example": "Sunset Yoga Studio"
    },
    "Notes": {
      "type": "string",
      "description": "Any notes about the class description.",
      "example": "Example note for Mindbody Public API."
    },
    "Prereq": {
      "type": "string",
      "description": "Any prerequisites for the class.",
      "example": "example-value"
    },
    "Program": {
      "$ref": "#/components/schemas/Program",
      "description": "Contains information about the class description's program."
    },
    "SessionType": {
      "$ref": "#/components/schemas/SessionType",
      "description": "Contains information about the class description's session type."
    },
    "Category": {
      "type": "string",
      "description": "The category of this class description.",
      "example": "example-value"
    },
    "CategoryId": {
      "type": "int32",
      "description": "The category ID of this class description.",
      "example": 123456
    },
    "Subcategory": {
      "type": "string",
      "description": "The subcategory of this class description.",
      "example": "example-value"
    },
    "SubcategoryId": {
      "type": "int32",
      "description": "The subcategory ID of this class description.",
      "example": 123456
    }
  }
}