Mindbody · Schema

ClassSchedule

Implementation of the 'ClassSchedule' model. Represents a single class instance. The class meets at the start time, goes until the end time.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
Classes array Contains information about a class.
Clients array Contains information about clients.
Course object Contains information about the course that the enrollment is a part of.
SemesterId integer The semester ID for the enrollment (if any).
IsAvailable boolean When `true`, indicates that the enrollment shows in consumer mode, has not started yet, and there is room in each class of the enrollment.
When `false`, indicates that either the enrollment does
Id integer The unique ID of the class schedule.
ClassDescription object Contains information about the class.
DaySunday boolean When `true`, indicates that this schedule occurs on Sundays.
DayMonday boolean When `true`, indicates that this schedule occurs on Mondays.
DayTuesday boolean When `true`, indicates that this schedule occurs on Tuesdays.
DayWednesday boolean When `true`, indicates that this schedule occurs on Wednesdays.
DayThursday boolean When `true`, indicates that this schedule occurs on Thursdays.
DayFriday boolean When `true`, indicates that this schedule occurs on Fridays.
DaySaturday boolean When `true`, indicates that this schedule occurs on Saturdays.
AllowOpenEnrollment boolean When `true`, indicates that the enrollment allows booking after the enrollment has started.
AllowDateForwardEnrollment boolean When `true`, indicates that this the enrollment shows in consumer mode, the enrollment has not started yet, and there is room in each class of the enrollment.
StartTime string The time this class schedule starts.
EndTime string The time this class schedule ends.
StartDate string The date this class schedule starts.
EndDate string The date this class schedule ends.
Staff object Contains information about the staff member who is regularly scheduled to teach the class.
Location object Contains information about the regularly scheduled location of this class.
FrequencyType object The class schedule recurrence type.
FrequencyInterval integer The interval between class schedule occurencies.
View JSON Schema on GitHub

JSON Schema

public-api-v6-class-schedule-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-class-schedule-schema.json",
  "title": "ClassSchedule",
  "description": "Implementation of the 'ClassSchedule' model. Represents a single class instance. The class meets at the start time, goes until the end time.",
  "type": "object",
  "properties": {
    "Classes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Class"
      },
      "description": "Contains information about a class.",
      "example": [
        {}
      ]
    },
    "Clients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Client"
      },
      "description": "Contains information about clients.",
      "example": [
        {}
      ]
    },
    "Course": {
      "$ref": "#/components/schemas/Course",
      "description": "Contains information about the course that the enrollment is a part of."
    },
    "SemesterId": {
      "type": "integer",
      "format": "int32",
      "description": "The semester ID for the enrollment (if any).",
      "example": 123456
    },
    "IsAvailable": {
      "type": "boolean",
      "description": "When `true`, indicates that the enrollment shows in consumer mode, has not started yet, and there is room in each class of the enrollment.<br /> When `false`, indicates that either the enrollment does not show in consumer mode, has already started, or there is no room in some classes of the enrollment.",
      "example": true
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The unique ID of the class schedule.",
      "example": 123456
    },
    "ClassDescription": {
      "$ref": "#/components/schemas/ClassDescription",
      "description": "Contains information about the class."
    },
    "DaySunday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Sundays.",
      "example": true
    },
    "DayMonday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Mondays.",
      "example": true
    },
    "DayTuesday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Tuesdays.",
      "example": true
    },
    "DayWednesday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Wednesdays.",
      "example": true
    },
    "DayThursday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Thursdays.",
      "example": true
    },
    "DayFriday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Fridays.",
      "example": true
    },
    "DaySaturday": {
      "type": "boolean",
      "description": "When `true`, indicates that this schedule occurs on Saturdays.",
      "example": true
    },
    "AllowOpenEnrollment": {
      "type": "boolean",
      "description": "When `true`, indicates that the enrollment allows booking after the enrollment has started.",
      "example": true
    },
    "AllowDateForwardEnrollment": {
      "type": "boolean",
      "description": "When `true`, indicates that this the enrollment shows in consumer mode, the enrollment has not started yet, and there is room in each class of the enrollment.",
      "example": true
    },
    "StartTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time this class schedule starts.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EndTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time this class schedule ends.",
      "example": "2026-05-28T14:30:00Z"
    },
    "StartDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date this class schedule starts.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EndDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date this class schedule ends.",
      "example": "2026-05-28T14:30:00Z"
    },
    "Staff": {
      "$ref": "#/components/schemas/Staff",
      "description": "Contains information about the staff member who is regularly scheduled to teach the class."
    },
    "Location": {
      "$ref": "#/components/schemas/Location",
      "description": "Contains information about the regularly scheduled location of this class."
    },
    "FrequencyType": {
      "$ref": "#/components/schemas/FrequencyTypeEnum",
      "description": "The class schedule recurrence type."
    },
    "FrequencyInterval": {
      "type": "integer",
      "format": "int32",
      "description": "The interval between class schedule occurencies.",
      "example": 1
    }
  }
}