API Reference

This reference is generated from the committed OpenAPI 3.1 specification. It is always in sync with the running API and is never hand-edited.

Examples-only. The requests shown here are copy-paste examples. There is no live “try it” execution in this reference. Run the examples against your own apps/server.

Grouped by tag. Operations are grouped into four tags: auth (login, register, refresh, me, logout, password reset, quickCode), tenancy (organizations, schools, classes, rollup), users (provisioning, profiles, rosters, principals, managers, parent links), and system (health).

Auth model. Protected operations use the bearerAuth (HTTP Bearer JWT) security scheme. Pass Authorization: Bearer <accessToken>. See Authentication.