list_course_enrollments
Read-only
Retrieve course enrollments with filters for role, state, user, and grade data.
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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| course_id | Yes | The Canvas course ID | |
| type | No | Filter by one or more enrollment types | |
| state | No | Filter by enrollment states | |
| role | No | Filter by custom role names | |
| include | No | Extra fields to include (Canvas include[] param) | |
| user_id | No | Filter to a specific user (may be numeric ID or "self") | |
| grading_period_id | No | Scope grade-related includes to this grading period | |
| enrollment_term_id | No | Limit to enrollments in the given term |