canvas announcements list
canvas announcements list¶
List announcements
Synopsis¶
List announcements for a course or multiple courses.
Examples:
canvas announcements list --course-id 123
canvas announcements list --course-id 123 --active-only
canvas announcements list --course-id 123 --start-date 2024-01-01 --end-date 2024-12-31
Options¶
--active-only Only return active announcements
--course-id int Course ID (required)
--end-date string End date (YYYY-MM-DD or ISO 8601)
-h, --help help for list
--include strings Include: sections, sections_user_count
--latest-only Only return the latest announcement per context
--start-date string Start date (YYYY-MM-DD or ISO 8601)
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas announcements - Manage Canvas announcements