As of summer 2026, MySchool is preparing to release the first batch of API's to allow your development teams to integrate with other software used by your school.
Your school must have the integrations module as part of your MySchool package. This also gives access to the Sync Centre. If you are interested in adding this to your existing package, please contact your CSM for further information.
What is an API?
Think of MySchool as a large filing cabinet full of information: student records, grades, attendance, courses, and more.
Normally, the only way to look at or change this information is through the screens people click through in the app.
An API is like a set of clearly labelled service doors around the back of that building. Other systems, such as your admissions or finance software, can use these doors to ask for specific things, like “give me the names of students enrolled in a class” or to add new information, without a person clicking any buttons.
We control which doors exist, and exactly what each one is allowed to do. The doors are called endpoints.
The four basic actions
Every API request is really just one of four simple actions. Think of it like the only four things you can ever do with a paper file in a cabinet.
| Action | Plain meaning | Everyday comparison |
| GET | Look at something | Asking to see a student's attendance record and being handed a copy to read. The original stays exactly as it was. |
| POST | Add something new | Handing in a form for a new student and saying, “Please file this; it does not exist yet.” |
| PUT | Update something that already exists | Pulling a file out of the cabinet, replacing the old sheet inside with a corrected one, and putting the file back. |
| DELETE | Remove something | Taking a file out of the cabinet and getting rid of it, for example, when a student leaves the school. |
| Quick way to remember it: GET reads, POST creates, PUT updates, DELETE removes. |
List versus retrieve
You will often see two GET actions for the same type of record.
| Action | What it returns |
| List | Many records at once, such as every course enrollment for a term. You get back a whole group. |
| Retrieve | One specific record, the one you already have an ID for, such as a single enrollment. |
Both are read-only. The difference is simply how many records you get back.
What is a webhook?
If an API is a door you knock on when you want something, a webhook is the building calling you the moment something happens inside, without you needing to keep checking.
Instead of another system constantly asking, “has a new grade been entered yet,” our system can simply say, the moment a grade is entered, “this just happened,” and send that information out automatically.
| Direction | How it works | |
| GET | Pull based | Another system has to actively ask every time. Nothing arrives unless it is requested. |
| Webhook | Push based | Our system sends the update automatically, the moment something happens, without being asked. |
Both are one-directional; they simply point in opposite directions. GET is the other system asking us. A webhook is us telling them, unprompted.
Putting it together
Think of it like a shop with a delivery service.
The API is the counter where other systems can order exactly what they need, when they need it.
The webhook is the shop calling ahead the moment an order is ready, instead of the customer having to keep walking back to check.
Together, these let other tools connect to our school software automatically, accurately, and in real time, without anyone needing to move information between systems by hand.
Comments
0 comments
Article is closed for comments.