Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
scopestring
Filters topics by a specific state. Only one state can be specified. Valid options: 'locked', 'unlocked', 'pinned', 'unpinned'.
includearray
Specifies additional data to return for each discussion topic. Valid options: 'all_dates', 'sections', 'sections_user_count', 'overrides'. Multiple options can be provided as a list of strings.
order_bystring
The criteria for ordering discussion topics. Defaults to 'position' if not specified. Valid options: 'position', 'recent_activity', 'title'.
per_pageinteger
Number of discussion topics to return per page (max 100).
course_idinteger
Required
The unique identifier of the course for which to list discussion topics.
filter_bystring
Filters topics based on a characteristic, typically read status. Use 'unread' to get only unread topics. Valid options: 'all', 'unread'.
search_termstring
A search string to match against discussion topic titles. Returns topics with partially matching titles.
only_announcementsboolean
If true, retrieves only announcements; otherwise, retrieves discussion topics. Defaults to false.
exclude_context_module_locked_topicsboolean
If true, and the requester is a student, excludes topics that are locked by module progression. Defaults to false.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not