canvas appointment-groups list
canvas appointment-groups list¶
List appointment groups
Synopsis¶
List appointment groups that can be reserved or managed by the current user.
Examples:
canvas appointment-groups list
canvas appointment-groups list --scope manageable
canvas appointment-groups list --scope reservable --include appointments,participant_count
canvas appointment-groups list --past
Options¶
--context strings Context codes to filter by (e.g. course_123)
-h, --help help for list
--include strings Additional fields: appointments, child_events, participant_count, reserved_times, all_context_codes
--past Include past appointment groups
--scope string Scope: reservable or manageable (default: reservable)
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 appointment-groups - Manage Canvas appointment groups