🚀 Heads up: Our API Docs Have Moved!
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
Cohort Announcements API
List a cohort's announcements for the cohort page. Members read cohort announcements through the Account Notifications API.
List a cohort's announcements CohortAccountNotificationsController#index
GET /api/v1/accounts/:account_id/cohorts/:cohort_id/account_notifications
Scope:
Return the announcements sent to this cohort, newest start_at first, ties
broken by highest id. Paginated. Deleted announcements never appear.
Requires manage_cohorts_announcements on the cohort.
url:GET|/api/v1/accounts/:account_id/cohorts/:cohort_id/account_notifications
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| include_past | boolean | Also return announcements whose end_at has passed, however long ago. Defaults to false. | |
| include_inherited | boolean | Also return announcements on ancestor cohorts that apply to descendant cohorts. An inherited row's cohort is the ancestor it lives on. Defaults to false. |
Example Request:
curl -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/accounts/2/cohorts/4002/account_notifications?include_inherited=true