List Course Enrollments
list_course_enrollmentsList enrollments within a specific course with Canvas filters. Use include=grades / include=current_points for richer grade data, type[] to limit to a role, and user_id to focus on a single user.
Instructions
List enrollments within a specific course with Canvas filters. Use include=grades / include=current_points for richer grade data, type[] to limit to a role, and user_id to focus on a single user.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"course_id": "<course_id>"
},
"name": "list_course_enrollments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role | No | Filter by custom role names | |
| type | No | Filter by one or more enrollment types | |
| state | No | Filter by enrollment states | |
| include | No | Extra fields to include (Canvas include[] param) | |
| user_id | No | Filter to a specific user. Canvas ID (pass large IDs as a string) or "self". | |
| course_id | Yes | The Canvas course ID | |
| grading_period_id | No | Scope grade-related includes to this grading period | |
| enrollment_term_id | No | Limit to enrollments in the given term |