get_subdomains
Get the list of school subdomains available to your account, with per-school login status, role, and active school. Use it to discover accessible schools and determine which require login or 2FA.
Instructions
List the school subdomains available to the logged-in account and the server's session status per school, plus overall login state. Read-only.
Args: (none)
Returns:
dict with:
- subdomains: list of school subdomains available to the account.
For a logged-in parent account this is live-discovered (via
edupage-api's get_subdomains, read from the profile page) and
includes schools with no session yet; it is limited to
EDUPAGE_SUBDOMAINS when that is set (allowlist), otherwise every
accessible school is listed. For student/teacher accounts or when
not logged in it falls back to the configured / current sessions.
- schools: per subdomain {subdomain, logged_in, role
(student/parent/teacher), user_id, two_factor_pending, active}.
When EDUPAGE_SUBDOMAINS is set it contains only the in-scope
schools (sessions for unconfigured schools are never listed).
- active_subdomain: the school used by tools without an explicit
subdomain argument.
- failed_logins: subdomain → error for login attempts that failed or
are blocked (e.g. pending 2FA at startup).
- env_*_set: whether EDUPAGE_USERNAME / EDUPAGE_PASSWORD /
EDUPAGE_SUBDOMAINS are configured.
Notes:
- Use this instead of the former auth_status / user_id tools.
- To connect to a discovered subdomain that has no session yet, pass
it to login_all.
- A school with two_factor_pending: True needs two_factor_finish.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||