Skip to main content

Forums

This query returns a forum containing discussion threads within a course, discussion widget, or assignment. The results of this query can be affected by providing an authToken header to set a user for the operation.

Forums(
  courseId: ID!
  clientId: ID
): [Forum!]

Arguments​

Forums.courseId ● ID! non-null scalar​

The ID of the course.

Forums.clientId ● ID scalar​

The ID of the client.

Type​

Forum object​

Examples​

Run in Postman

Query:​

Forums(
 $courseId: ID!,
 $clientId: ID
) {
 Forums(
   courseId: $courseId,
   clientId: $clientId
 ) {
   id
   course {
     ...CourseFragment
   }
   sectionId
   label
   threadsCount
   createdAt
   updatedAt
   isGeneral
 }
}

Variables:​

{
 "courseId": "0e99a117-e3b6-40a6-867c-6b3bbc166b41",
 "clientId": "0e99a117-e3b6-40a6-867c-6b3bbc166b41"
}

Response:​

{
  "data": {
    "Forums": [
      {
        "id": "0e99a117-e3b6-40a6-867c-6b3bbc166b41",
        "course": "Course",
        "sectionId": "0e99a117-e3b6-40a6-867c-6b3bbc166b41",
        "label": "xyz789",
        "threadsCount": 116,
        "createdAt": "2025-03-26T13:39:48.013Z",
        "updatedAt": "2025-03-26T13:39:48.013Z",
        "isGeneral": true
      }
    ]
  }
}