canvas appointment-groups
canvas appointment-groups¶
Manage Canvas appointment groups
Synopsis¶
Manage Canvas appointment groups (office hours, sign-up slots, etc.).
Appointment groups provide a way of creating a bundle of time slots that users can sign up for (e.g. "Office Hours" or "Meet with professor about Final Project"). Both time slots and reservations of time slots are stored as Calendar Events.
Examples:
canvas appointment-groups list
canvas appointment-groups list --scope manageable
canvas appointment-groups get 543
canvas appointment-groups create --context course_123 --title "Office Hours"
canvas appointment-groups users 543
canvas appointment-groups next
Options¶
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")
--quiet Suppress informational messages, only output data and errors
--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 - Canvas LMS CLI - Interact with Canvas from the command line
- canvas appointment-groups create - Create an appointment group
- canvas appointment-groups delete - Delete an appointment group
- canvas appointment-groups get - Get an appointment group
- canvas appointment-groups groups - List appointment group student groups
- canvas appointment-groups list - List appointment groups
- canvas appointment-groups next - Get next available appointment
- canvas appointment-groups update - Update an appointment group
- canvas appointment-groups users - List appointment group participants