Class Manager
GET /v1/courses/{id}

Get Course

Path parameters

  • id string Required

    Course id

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • aggregateId string Required

      aggregateId

    • entity object Required

      Class schema

      Hide entity attributes Show entity attributes object
      • id string Required

        id

      • companyId string Required

        Company ID

      • seasonId string | null Required

        Season ID

      • seasonName string Required

        Season name

      • firstLessonStartDate string(date) | null Required

        Drop in first lesson start date

      • lastLessonEndDate string(date) | null Required

        Drop in first lesson end date

      • name string Required

        Dance

      • type string Required

        Values are enrolment or drop-in.

      • is_recurring boolean Required

        Whether the class repeats

      • dayOfWeek string Required

        Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

      • startTime string Required

        Start time

      • durationInMinutes integer Required

        Duration in minutes

      • price integer | null Required

        Price

      • image string | null Required

        Image

      • description string | null Required

        Description

      • roomId string | null

        Room ID

      • staffId string | null

        Staff ID

      • minAgeMonths integer Required

        Min age in months

      • maxAgeMonths integer Required

        Max age in months

      • capacity integer Required

        Capacity

      • colorId string Required

        Values are red, orange, yellow, lime, green, turquoise, sky, blue, purple, pink_purple, pink, or grey.

      • archivedAt string(date-time) | null Required

        Archived at date

      • deletedAt string(date-time) | null Required

        Deleted at date

    • settings object Required

      Class schema

      Hide settings attributes Show settings attributes object
      • id string | null

        Class setting ID

      • classId string Required

        Class ID

      • portalEnrolmentEnabled boolean Required

        Portal enrolment enabled

      • discountable boolean Required

        Discountable

      • trialsEnabled boolean Required

        Trials enabled

      • taxRateId string | null

        Tax rate ID

    • stats object Required

      Class stats schema

      Hide stats attributes Show stats attributes object
      • classId string Required

        Class ID

      • enrolments object Required

        Enrolment stats schema

        Hide enrolments attributes Show enrolments attributes object
        • currentCount integer Required

          Current Count

        • upcomingCount integer Required

          Upcoming Count

        • pastCount integer Required

          pastCount

      • waitingLists object Required

        Waiting list stats schema

        Hide waitingLists attribute Show waitingLists attribute object
        • totalCount integer Required

          Total Count

      • trials object Required

        Trial stats schema

        Hide trials attributes Show trials attributes object
        • totalCount integer Required

          Total Count (All exc archived and deleted)

        • upcomingCount integer Required

          Upcoming Count (Trials in the future exc archived & deleted)
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/courses/{id} 
curl \
 --request GET 'https://api.classmanager.io/v1/courses/cls_xxxxxxxx'
Response examples (200) 
{
  "aggregateId": "cls_xxxxxxxxxxx",
  "entity": {
    "id": "cls_123123123123",
    "companyId": "co_123123123123",
    "seasonId": "sea_123123123123",
    "seasonName": "Winter 2024",
    "firstLessonStartDate": "2023-12-05",
    "lastLessonEndDate": "2023-12-05",
    "name": "All That Jazz",
    "type": "enrolment",
    "is_recurring": true,
    "dayOfWeek": "monday",
    "startTime": "10:00",
    "durationInMinutes": 60,
    "price": 50,
    "image": "https://",
    "description": "Description",
    "roomId": "rm_123123123123",
    "staffId": "stf_123123",
    "minAgeMonths": 2,
    "maxAgeMonths": 5,
    "capacity": 20,
    "colorId": "red",
    "archivedAt": "2023-12-05 14:30:41",
    "deletedAt": "2023-12-05 14:30:41"
  },
  "settings": {
    "id": "clstn_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "classId": "cls_xxxxxxxxxxxxxxxx",
    "portalEnrolmentEnabled": true,
    "discountable": true,
    "trialsEnabled": false,
    "taxRateId": "tax_xxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "stats": {
    "classId": "cls_xxxxxxxxx",
    "enrolments": {
      "currentCount": 10,
      "upcomingCount": 2,
      "pastCount": 4
    },
    "waitingLists": {
      "totalCount": 4
    },
    "trials": {
      "totalCount": 10,
      "upcomingCount": 10
    }
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}