Query parameters

• page integer

  Page number (1-indexed)

  Minimum value is 1. Default value is 1.

• pageSize integer

  Number of classes per page

  Minimum value is 1, maximum value is 100. Default value is 10.

• sort string

  Sort field and direction (e.g., 'name-asc', 'createdAt-desc')

• search string

  Search by class name

• isActive boolean

  Filter by active status

Responses

• 200 application/json

  List of classes retrieved successfully

  Hide response attributes Show response attributes object

  • success boolean
  • code integer(int32)
  • message string
  • data array[object]

    Class (learning group) representing a classroom with enrolled students

    Hide data attributes Show data attributes object

    • id string Required

      Unique identifier for the class

    • ownerId string Required

      ID of the teacher/owner who created the class

    • name string Required

      Name of the class (e.g., "10A1", "11B2")

      Maximum length is 50.

    • description string | null

      Description or notes about the class

    • joinCode string | null

      Unique join code for students to enroll

      Maximum length is 10.

    • settings object | null

      Class-specific settings like theme, allow_comments, etc.

    • isActive boolean

      Whether the class is active

    • createdAt string(date-time)

      Timestamp when the class was created

    • updatedAt string(date-time)

      Timestamp when the class was last updated

  • pagination object
    Hide pagination attributes Show pagination attributes object

    • currentPage

      The current page number (1-based indexing)

    • pageSize

      Number of items per page

    • totalItems

      Total number of items across all pages

    • totalPages

      Total number of available pages

• 401 application/json

  Unauthorized - Invalid or missing authentication token

  Hide response attributes Show response attributes object

  • success boolean
  • code integer
  • errorCode string
  • message string
  • timestamp string(date-time)
• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • success boolean
  • code integer
  • errorCode string
  • message string
  • timestamp string(date-time)