Integrations - API endpoints – MySchool Support

Please note that REST API's

This article lists the information available through our API, grouped by area, with a plain explanation of what each one represents. For an explanation of what GET, POST, PUT, DELETE and webhooks actually mean, check out this article here.

A note on profiles

Several areas below refer to a “person.” A person is a general profile record. That same profile is then treated as a student, a staff member, or a guardian, depending on the role that person holds at the school. For example, a guardian profile and a staff profile both draw from the same underlying person information, such as name, contact details, and nationality, with extra details layered on top depending on their role.

Entities, endpoints, and field attributes

Once the module is activated, your development team will have access to a new page with dev guidelines (/api/v1/docs#tag/). An entity is the actual record, so in the example below, it is a guardian. The endpoint for retrieving this is GET/foundation/guardians/{id}.

An example in terms of creating a guardian entity in MySchool;

The API can retrieve a guardian profile from an external system. Note that this still must be combined with a relationship and a student for it to be classed as a guardian.

Admissions

This area covers everything related to someone applying to join a school.

Item	What it is	What you can do
Applicant	A person who has applied to enrol in a program.	View a list, view one record, or add a new one.
Applicant Status	The current stage of an applicant's progress through the admissions process, such as submitted, under review, or accepted.	View a list, or view one record.
Program	An academic program that a student can apply to join.	View a list, or view one record.
Program Requirement	A specific requirement tied to a program, such as a document or qualification needed to apply.	View a list, or view one record.
Program Stream	A particular track or pathway within a wider program.	View a list, or view one record.
Program Type	The category or classification a program falls under.	View a list, or view one record.
Qualification Type	A type of prior qualification an applicant may already hold.	View a list, or view one record.

Courses

This area covers academic lessons and how people relate to them.

Item	What it is	What you can do
Course	A specific academic class or lesson offering, such as a particular Maths class.	View a list, view one record, add a new one, update it, or remove it.
Course Enrollment	The record linking a person to a course they are enrolled in.	View a list, view one record, add a new one, update it, or remove it.
Course Teacher	The record linking a teacher to a course they teach.	View a list, view one record, add a new one, update it, or remove it.
Subject	The academic subject a course belongs to, such as Maths or Geography.	View a list, view one record, add a new one, update it, or remove it.

Foundation

This area covers the core building blocks used across the rest of the system, including profiles, school structure, and reference information.

Item	What it is	What you can do
Academic Year	A school year, including its start and end dates.	View a list or view one record.
Audience	A defined group used for targeting communications or content.	View a list, or view one record.
Class Enrollment	The record linking a person to a class they are enrolled in.	View a list, view one record, add a new one, update it, or remove it.
Class Level	A level within the school's class structure.	View a list, view one record, add a new one, update it, or remove it.
Class Teacher	The record linking a teacher to a class.	View a list, view one record, add a new one, update it, or remove it.
Country	A country reference used across profiles and addresses.	View a list, or view one record.
District	A school district within the wider network.	View a list, view one record, add a new one, update it, or remove it.
Gender	A gender reference used across profiles.	View a list or view one record.
Guardian	A profile representing a parent or guardian of a student.	View a list, view one record, or update it.
Class	A specific class group within a school.	View a list, view one record, add a new one, update it, or remove it.
Language	A language reference used across profiles.	View a list, or view one record.
Nationality	A nationality reference used across profiles.	View a list, or view one record.
Person	A general profile record. See “A note on profiles” above.	View a list, view one record, add a new one, or update it.
Phone Number	A phone number attached to a profile.	View a list, view one record, add a new one, update it, or remove it.
Phone Type	The category of a phone number, such as mobile, home, or work.	View a list, or view one record.
Relationship	A link describing how two people are related, such as parent or sibling.	View a list, view one record, add a new one, update it, or remove it.
Relationship Type	The category a relationship falls under.	View a list or view one record.
Building	A physical building within a school.	View a list or view one record.
School	An individual school within the network.	View a list, view one record, add a new one, update it, or remove it.
School Level	A level of schooling offered at a school, such as primary or secondary.	View a list, view one record, add a new one, update it, or remove it.
Staff Member	A profile representing a staff member.	View a list or view one record.
Student	A profile representing a student.	View a list, view one record, or update it.

Webhooks

Webhooks notify connected systems automatically whenever certain events happen, without needing to be asked. Each of the following fires a notification the moment the event occurs.

Item	What it is	What you can do
Course	Created, updated, or deleted.	Sends a notification automatically; you do not request this.
Subject	Created, updated, or deleted.	Sends a notification automatically; you do not request this.
Class (referred to internally as klass)	Created, updated, or deleted.	Sends a notification automatically; you do not request this.
Person	Created, updated, or deleted.	Sends a notification automatically; you do not request this.
Phone Number	Created, updated, or deleted.	Sends a notification automatically; you do not request this.

Developing API's

We cannot provide a service to create the API's for third-party software. There are solutions on the marketplace that can facilitate this for non-technical users, such as Zapier.

Other modules?

We are committed to providing further API's for other areas of the system, but they will not be included in the initial launch version. Why not follow this section for new articles about integrations when they are released.

Articles in this section

Integrations - API endpoints