Class Manager
GET /v1/courses/

List Course

Query parameters

  • where object

    App\Classes\Core\Models\Course Filters: 0, 1, 2, 3, 4

    Hide where attributes Show where attributes object
  • sort object

    App\Classes\Core\Models\Course Sorting by name, startTime

    Hide sort attributes Show sort attributes object
    • name string

      Values are asc or desc.

    • startTime string

      Values are asc or desc.

  • onlyArchived boolean

    Determines whether to return only archived records in the response.

Responses

  • 200 application/json

    Paginated response

    Hide response attributes Show response attributes object
    • data array[object] Required

      Class with related details schema

      Hide data attributes Show data 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 Required

          Season ID

        • name string Required

          Dance

        • 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)

    • pagination object Required

      Pagination schema

      Hide pagination attributes Show pagination attributes object
      • total integer Required

        Total number of items

      • count integer Required

        Number of items on this page

      • perPage integer

        Number of items per page

      • currentPage integer

        Current page number

      • totalPages integer

        Total number of pages
  • 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
GET /v1/courses/ 
curl \
 --request GET 'https://classmanager.test/v1/courses/'
Response examples (200) 
{
  "data": [
    {
      "aggregateId": "cls_xxxxxxxxxxx",
      "entity": {
        "id": "cls_123123123123",
        "companyId": "co_123123123123",
        "seasonId": "sea_123123123123",
        "name": "All That Jazz",
        "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
        }
      }
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}