Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Super Admin question bank, schools, rollover, exports, goals, and sharing.
| Method | Path | Body / query |
|---|---|---|
GET | /api/school-year?schoolYear=2026-2027 | Any authenticated user. Also returns cycle (latest/next year, term dates, carry-over preview) |
POST | /api/school-year | Super Admin. { fromYear? } creates the next July–June cycle. 409 if it already exists |
PUT | /api/school-year | Super Admin. { schoolYear, archived?, questionBankVersion?, deadlines?, districtGoals? } |
POST | /api/admin/forms/rollover | { sourceYear, targetYear, force? } |
GET | /api/admin/forms/export?schoolYear=2026-2027&format=csv | format: csv | html |
GET POST | /api/admin/forms/populate-bank | Super Admin. Seed a plan from a published question bank. POST { formId, apply: true, fillAnswers?, force?, label?, version? }. fillAnswers: true writes sample responses for every question. CLI: src/scripts/populate-form-from-bank.js (--answers --apply --force). |
GET POST | /api/admin/forms/migrate-contacts | Super Admin. Convert old textarea contact answers into table rows. GET ?year= lists questions. POST { year, questionId, apply?, formIds? } |
POST /api/admin/questions/seed
{ "force": false }
POST /api/admin/questions/publish
{ "confirm": true, "schoolYear": "2026-2027" }
| Method | Path | Notes |
|---|---|---|
GET | /api/admin/principals | Level 4 list for assignment UIs |
GET POST | /api/admin/users/school | School-scoped user listing / create helpers |
POST GET DELETE | /api/admin/forms/share | Collaboration assignments |
GET POST | /api/admin/schools | Super Admin school catalog. GET ?active=1 for dropdowns. POST { name, dbn?, notes? } (20 / 60s) |
PATCH DELETE | /api/admin/schools/[id] | Super Admin. Rename updates users and plans. Delete only if unused; otherwise deactivate |
| Method | Path | |
|---|---|---|
GET | /api/admin/goals | Year-scoped goal clusters |
POST | /api/admin/reports | Submissions CSV. Body: { startDate?, endDate?, status? }. Principals: own school only (schoolScopeFilter) |
GET | /api/admin/timeline | Activity timeline; same school scope as reports |
GET | /api/notifications | Plan-owner review pings (not Super Admin-only) |
GET POST | /api/admin/health |
GET /api/admin/health returns API / MongoDB / Redis sizes and pings. POST body { "action": "flush-cache" } or { "action": "retry-redis" }. See System health.
POST /api/admin/forms/live { formId, live } reopens one archived-year plan (or returns it to read-only). Year-wide unlock is PUT /api/school-year with { schoolYear, archived: false }. See School year.Was this page helpful?