get_my_students
Retrieve the students linked to your EduPage account—parents see their children, students/teachers see classmates—to enable student switching and timetable access.
Instructions
Get the students visible to the logged-in account. Read-only: parent accounts see their linked children (parsed from the school homepage); student/teacher accounts see classmates. Uses cached data.
Args: subdomain: School to query (defaults to the active subdomain).
Returns:
dict: {'subdomain', 'students': [{person_id, name, class_id, ...}]}
usable with switch_to_student and get_student_timetable.
Notes:
- Prefer get_my_students over get_roster to see your children /
classmates; get_roster(roster_type='all_students') lists the whole
school.
- Cache is refreshed by clear_student_cache; scan_students returns
the same visibility across all schools.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subdomain | No |