canvas groups list
canvas groups list¶
List groups
Synopsis¶
List groups for a course, account, or user.
Examples:
canvas groups list --course-id 123
canvas groups list --account-id 1
canvas groups list --user-id 456
canvas groups list # Lists current user's groups
Options¶
--account-id int Account ID
--course-id int Course ID
-h, --help help for list
--include-permissions Include permissions
--include-users Include group users
--user-id int User ID (0 for self)
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 groups - Manage Canvas groups