canvas_list_students
List students enrolled in a Canvas course, with optional email inclusion, name/login search filtering, and FERPA-compliant PII redaction via hashes.
Instructions
List the students enrolled in a course.
FERPA: returns student names, and email addresses when include_email=True. With CANVAS_REDACT_PII=1 identifiers come back as stable hashes instead.
Args: course_id: numeric course id; defaults to CANVAS_DEFAULT_COURSE_ID. include_email: also request email addresses (default False). search_term: optional name/login substring filter (3+ characters).
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "canvas_list_students"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| course_id | No | ||
| search_term | No | ||
| include_email | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |