List Course Users
list_course_usersRead-only
Lists users enrolled in a Canvas course with optional filters for enrollment type/state, search term, user IDs, and sort order; can include additional fields like email and bio.
Instructions
List users in a course with optional Canvas filters. Use include to request email, enrollments, avatar_url, bio, and other fields otherwise omitted from the default response. Use enrollment_type / enrollment_state to narrow by role or status, search_term to filter by name/login, user_ids to fetch a specific subset, and sort/order to control ordering.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort field | |
| order | No | Sort order | |
| include | No | Extra fields to include on each user (Canvas include[] param) | |
| user_ids | No | Restrict the result to the given user IDs | |
| course_id | Yes | The Canvas course ID | |
| search_term | No | Partial name or full login/SIS ID to filter users by | |
| enrollment_type | No | Filter by one or more enrollment types | |
| enrollment_state | No | Filter by enrollment state (e.g. active, invited) |