Skip to main content

List School Years

Retrieve all school years (academic years) for the current school, ordered by start date descending.

Response


Create School Year

Create a new school year (academic year) for the current school.

Request Body


List Academic Periods

Retrieve all academic periods (terms/quarters) for the current school, optionally filtered by school year.

Query Parameters

Response


Create Academic Period

Create a new academic period within a school year.

Request Body


Upload School Media

Upload institutional media files such as logos, images, or documents.

Request Body (multipart/form-data)

Response

File Upload Notes

Status Values Reference

School Year Status

StatusDescription
planningYear is being planned, not yet active
activeCurrently active academic year
completedYear has ended, records finalized
archivedArchived for historical reference

Academic Period Status

StatusDescription
draftPeriod planned but not yet started
activeCurrently active period
closedPeriod completed, grades finalized
archivedArchived for historical reference

Permissions

OperationRequired Permission
List Years/Periodsread:all, read:grades, or read:schedule
Create Year/Periodconfig:institution or write:all
Upload Mediaconfig:institution or write:all

Best Practices

Build docs developers (and LLMs) love