Skip to main content
objectCourse

Implements

Fields

avatarDarkModeUrl
String

Dark-mode variant of the avatar image URL.

avatarUrl
String

Avatar image URL.

Coursework items within the course, ordered by position. Filter by type, status, or a parent item. Items that are not posted are listed for a Host or moderator of the course, or when includeUnpublished is true for a Network Host token holding host:read:network_posts, host:read:network, or host:write:network_posts.

Arguments
after
String

Returns the elements in the list that come after the specified cursor.

before
String

Returns the elements in the list that come before the specified cursor.

first
Int

Returns the first n elements from the list.

includeDisallowedPostTypes
Boolean

Pass true, as a Network Host or Network moderator, to also return posts whose type their Space does not allow: a type whose feature is off in that Space, such as Events for an event. Otherwise they are left out. Anyone else passing true gets the default.

includeUnpublished
Boolean
default:false

Include coursework that is not posted. For a Network Host without a role in the course, requires host:read:network_posts, host:read:network, or host:write:network_posts.

last
Int

Returns the last n elements from the list.

parentId
ID

Only the direct children of this coursework item (its resource ID or GlobalID).

Only items with this visibility status. Narrows what the viewer may already see, so any value but POSTED returns nothing unless unpublished coursework is visible to the viewer.

statuses

Only items with one of these visibility statuses. Narrows what the viewer may already see, like status; when both are passed, an item must match both. An empty list applies no filter.

Only items of this kind (lesson, quiz, section, overview).

createdAt
ISO8601DateTime

When the Space was created.

descriptionHtml
String

The course's description as sanitized HTML.

descriptionText
String

The course's description as plain text, with HTML stripped.

id
ID!

ID of the object.

Posts, events, and polls that make up the course's content. Coursework that is not posted is included for a Host or moderator of the course, or when includeUnpublished is true for a Network Host token holding host:read:network_posts, host:read:network, or host:write:network_posts.

Arguments
after
String

Returns the elements in the list that come after the specified cursor.

before
String

Returns the elements in the list that come before the specified cursor.

first
Int

Returns the first n elements from the list.

includeDisallowedPostTypes
Boolean

Pass true, as a Network Host or Network moderator, to also return posts whose type their Space does not allow: a type whose feature is off in that Space, such as Events for an event. Otherwise they are left out. Anyone else passing true gets the default.

includeUnpublished
Boolean
default:false

Include coursework that is not posted. For a Network Host without a role in the course, requires host:read:network_posts, host:read:network, or host:write:network_posts.

last
Int

Returns the last n elements from the list.

resourceId
ID!

Resource ID for this object, for interop with the Admin API.

title
String!
updatedAt
ISO8601DateTime

When the Space record last changed.

url
String!

Canonical web URL.