canvas calendar list
canvas calendar list¶
List calendar events
Synopsis¶
List calendar events for courses, groups, or users.
Examples:
canvas calendar list --course-id 123
canvas calendar list --context course_123,course_456
canvas calendar list --start-date 2024-01-01 --end-date 2024-01-31
canvas calendar list --type assignment
canvas calendar list --all-events
Options¶
--all-events Return all events (ignore date filters)
--context strings Context codes (course_123, user_456)
--course-id int Course ID (adds course context)
--end-date string End date (YYYY-MM-DD or ISO 8601)
-h, --help help for list
--important-dates Only important dates
--start-date string Start date (YYYY-MM-DD or ISO 8601)
--type string Event type: event, assignment, sub_assignment
--undated Only return undated events
--user-id int User ID (list events for specific user)
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 calendar - Manage Canvas calendar events