MySchool data will be readable and writable by the other systems your school runs.
MySchool is proud to announce the launch of our new client-facing API.
For the first time, MySchool data will be directly accessible through an OpenAPI interface, giving other software direct, two-way access. External systems will be able to query student, staff, and enrolment records straight from MySchool, push updates back into it, and subscribe to real-time notifications whenever a record changes. Once you connect a system, data will flow automatically between the two. No manual exports, no re-entering information by hand.
It will enter beta in the coming months.
Here is what it will do and what it will let you build.
What an API is
An API is a way for two pieces of software to talk to each other directly, without a person in the middle.
Today, moving information between MySchool and another system means using one of our pre-built integrations. Otherwise, it means someone on your staff exports a file, checks it, uploads it somewhere else, then repeats the same steps next week when something changes. An API removes that step. Another system will be able to ask MySchool for information and get an answer in seconds, and it will be able to send information the other way, securely.
A useful comparison: Think of a travel website. You don’t need to log into the airline's website, the hotel's website, and the car rental site separately to book a whole trip. The travel site uses APIs to talk to all of them at once, pulling in the flight times, hotel availability, and rental prices automatically so you can see them in one place. We are building that same kind of 'connector' for MySchool data, so your other school systems can pull information automatically instead of forcing you to move it manually.
What the API will cover
Covered entities will include students, staff, guardians, classes, courses, enrolments and more. The API will support both reads and writes, so a connected system will be able to retrieve records from MySchool and update them.
It will also support webhooks. MySchool will notify another system the moment something changes, rather than leaving that system to check repeatedly. This is what will make near real-time syncing possible, instead of overnight batching.
The API won’t cover every entity at launch. MySchool’s data model is extensive, and we’re rolling out coverage in phases, prioritizing the entities most systems need first. Coverage will keep expanding, and you can request specific entities through the suggestions portal.
How your school will use it
Connecting a third-party system. Say you run a separate learning platform. Today, when a student joins mid-term, someone needs to either enter their details manually or import them from a spreadsheet. With the API, the new enrolment record will trigger a webhook, and a platform able to receive it will create the account within minutes, so the student will have access the same day. If that student later changes classes, the class list will update on both sides without anyone touching it.
Connecting an in-house system. Your group has built its own reporting dashboard for senior leadership, and at the moment it runs on exported files that are days old. With the API, it will read live enrolment and course data, so your leadership team will be looking at today's numbers. The connection will work the other way too. Data created in your other systems can be written back into MySchool, so a new staff member added in your HR system arrives in MySchool without anyone creating the record a second time.
Why we built it
Until now, every connection to MySchool has depended on us, whether that was a pre-built integration with a specific third-party system or a bespoke build. Anything we did not cover fell back to manual file handling. Schools have repeatedly asked us to connect MySchool to third-party systems and to software they have built in-house, and each of those requests had to be handled individually.
That leaves three linked problems.
- Manual data handling. Exports and imports take your staff time and introduce errors.
- Stale data. Information in a connected system is only as current as your last export.
- Waiting on our roadmap. Every new integration required our involvement, which meant a place in a queue.
The API will turn a run of one-off requests into a capability you manage yourself, on your own timeline. The short version: your school data will stop living in one system and start working across all of them.
Who it is for
- School IT teams with development capability. The primary audience for this release. They will be able to build and own integrations directly.
- Larger schools, groups and networks. The value will scale with the number of students, systems and sites involved. A group running the same manual process across ten schools will save ten times over.
- Schools with in-house built systems. Portals, dashboards and custom tools. These have been the hardest for us to support until now.
What to do next
If you want to use it, three things are worth stating:
- API access sits inside the API & Integration package. Talk to your Customer Success Manager to confirm whether it is already covered by your contract.
- The API will require development work, either from your own team or from a partner. It is a capability your school builds on, not a switch you turn on.
- Behaviour may change during beta, so early adopters should expect that.
Beta places are limited. We are opening access for three schools first, allocated in the order interest is registered. A wider release will follow shortly after those three schools are live.
To signal your interest, contact your Customer Success Manager.
Documentation will be published at launch.
.png)
