Forums

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

Query:

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

Variables:

{
 "courseId": "58ccb96c-8e90-4464-86e0-f284442981df",
 "clientId": "58ccb96c-8e90-4464-86e0-f284442981df"
}

Response:

{
  "data": {
    "Forums": [
      {
        "id": "58ccb96c-8e90-4464-86e0-f284442981df",
        "course": "Course",
        "sectionId": "58ccb96c-8e90-4464-86e0-f284442981df",
        "label": "xyz789",
        "threadsCount": 678,
        "createdAt": "2023-12-20T16:58:58.782Z",
        "updatedAt": "2024-06-20T16:58:58.782Z",
        "isGeneral": true
      }
    ]
  }
}