How services work
Every endpoint belongs to one service, and an app is granted services as scopes shaped service plus access, such as students:read or fees:write. Read scopes cover the GET routes. Write scopes cover the others. Write access, billable services and money-out need a school administrator to approve. An app receives a webhook event only while it holds the read scope of the service the event belongs to.
Every service
20 services and 58 endpoints, generated from the API specification.
- School1 endpointThe school profile your key belongs to.Read
school:readWriteNoneView endpoints - Students4 endpointsList, read, enrol and update students.Read
students:readWriteView endpointsstudents:write - Guardians3 endpointsGuardians and the students they are linked to.Read
guardians:readWriteNoneView endpoints - Staff2 endpointsStaff records, never bank details.Read
staff:readWriteNoneView endpoints - Sessions and terms3 endpointsAcademic sessions and their terms. Read only.Read
sessions:readWriteNoneView endpoints - Classes3 endpointsClass levels, sections and the subjects each class takes. Read only.Read
classes:readWriteNoneView endpoints - Subjects2 endpointsThe subjects the school teaches. Read only.Read
subjects:readWriteNoneView endpoints - Attendance4 endpointsRead registers and mark attendance, with the same absence notices a dashboard mark sends.Read
attendance:readWriteView endpointsattendance:write - Timetable2 endpointsPublished timetables only. Read only.Read
timetable:readWriteNoneView endpoints - Assignments2 endpointsPublished assignments. Read only.Read
assignments:readWriteNoneView endpoints - Results1 endpointPublished report cards. Read only.Read
results:readWriteNoneView endpoints - Fees3 endpointsFee structures, a student's fee account, and payment through the school's own payment provider.Read
fees:readWriteView endpointsfees:write - Wallet1 endpointThe service wallet balance. Read only.Read
wallet:readWriteNoneView endpoints - Money-out4 endpointsPayout accounts, withdrawals and payroll payment. Live keys only, behind extra checks.Read
moneyOut:readWriteView endpointsmoneyOut:write - Messaging7 endpointsSMS, email, push and announcements to people in the school, and their delivery status.Read
messaging:readWriteView endpointsmessaging:write - AI3 endpointsLesson notes and questions from the school's shared daily AI allowance.Read
ai:readWriteView endpointsai:write - MCP1 endpointThe Model Context Protocol endpoint for AI agents.ReadNoneWriteView endpoints
mcp:write - Documents3 endpointsReport card, transcript and receipt PDFs, rendered on request.Read
documents:readWriteNoneView endpoints - Public4 endpointsWhat a school website or app can show anyone. Works with a publishable key.Read
public:readWriteView endpointspublic:write - End-user sign-in5 endpointsSign parents, students and staff in to your app. Secret key only.ReadNoneWriteView endpoints
auth:write