GET /classes/{classId}/posts

Retrieves a paginated list of posts in a class (announcements, events, discussions).

Path parameters

  • classId string Required

    The class ID

Query parameters

  • type string

    Filter by post type

    Values are announcement, schedule_event, or general.

  • page integer

    Page number (1-based)

    Minimum value is 1. Default value is 1.

  • pageSize integer

    Items per page

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

Responses

  • 200 application/json

    Posts retrieved successfully

    Hide response attributes Show response attributes object
    • success boolean
    • code integer(int32)
    • message string
    • data array[object]

      Post representing announcements, schedule events, or general messages in a class

      Hide data attributes Show data attributes object
      • id string Required

        Unique identifier for the post

      • classId string Required

        ID of the class

      • authorId string Required

        ID of the post author

      • author object | null

        Author information (populated on GET)

        Hide author attributes Show author attributes object | null
        • id string
        • firstName string
        • lastName string
        • avatarUrl string
      • content string Required

        Content of the post

      • type string Required

        Type of post

        Values are announcement, schedule_event, or general.

      • attachments array[string(uri)] | null

        Array of attachment URLs

      • linkedResources array[string] | null

        Array of linked resource IDs (lesson IDs or individual resource IDs)

      • linkedLesson object | null

        If a lesson is linked, includes lesson data with its resources combined with individual resources

        Hide linkedLesson attributes Show linkedLesson attributes object | null
        • id string
        • title string
        • resources array[object]

          Lesson resource representing teaching materials and resources

          Hide resources attributes Show resources attributes object
          • id string Required

            Unique identifier for the resource

          • lessonId string Required

            ID of the lesson

          • name string Required

            Name of the resource

            Maximum length is 200.

          • type string Required

            Type of resource

            Values are presentation, mindmap, document, video, audio, image, worksheet, equipment, or other.

          • url string(uri) | null

            URL of the resource

          • filePath string | null

            File path of the resource

          • description string | null

            Description of the resource

          • isRequired boolean

            Whether the resource is required for the lesson

          • isPrepared boolean

            Whether the resource has been prepared

          • createdAt string(date-time)

            Timestamp when the resource was created

      • isPinned boolean

        Whether post is pinned

      • allowComments boolean

        Whether comments are allowed on this post

      • createdAt string(date-time)

        Timestamp when post was created

      • updatedAt string(date-time)

        Timestamp when post 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)
  • 404 application/json

    Class not found

    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)
GET /classes/{classId}/posts
curl \
 --request GET 'https://api.huy-devops.site/api/classes/{classId}/posts' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "success": true,
  "code": 200,
  "message": "string",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440008",
      "classId": "550e8400-e29b-41d4-a716-446655440000",
      "authorId": "550e8400-e29b-41d4-a716-446655440001",
      "author": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "avatarUrl": "string"
      },
      "content": "Check out this lesson on quadratic equations",
      "type": "announcement",
      "attachments": [
        "https://example.com/file.pdf"
      ],
      "linkedResources": [
        "550e8400-e29b-41d4-a716-446655440005"
      ],
      "linkedLesson": {
        "id": "string",
        "title": "string",
        "resources": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440006",
            "lessonId": "550e8400-e29b-41d4-a716-446655440005",
            "name": "Quadratic Formula Worksheet",
            "type": "document",
            "url": "https://example.com/worksheet.pdf",
            "filePath": "/uploads/worksheet.pdf",
            "description": "Practice worksheet for quadratic equations",
            "isRequired": true,
            "isPrepared": false,
            "createdAt": "2024-01-15T10:30:00Z"
          }
        ]
      },
      "isPinned": false,
      "allowComments": true,
      "createdAt": "2024-09-20T10:30:00Z",
      "updatedAt": "2024-09-20T14:45:00Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}
Response examples (401)
{
  "success": false,
  "code": 42,
  "errorCode": "string",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Response examples (404)
{
  "success": false,
  "code": 42,
  "errorCode": "string",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Response examples (500)
{
  "success": false,
  "code": 42,
  "errorCode": "string",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}