Change log

July 12, 2025

• Updated GET /v2p0/classes/:class_id/attendance/date/:date endpoint to with extended category details.

June 13, 2025

• Added POST /v2/classes/:class_id/teachers/add_teachers endpoint to add Teachers to a Class.

• Added DELETE /v2/classes/:class_id/teachers/remove_teachers endpoint to remove Teachers from a Class.

June 12, 2025

• Added attendance_categories details to /v2/classes/:class_id/attendance/term/:term_id endpoint response

May 29, 2025

• Added GET /v2/classes/:class_id/teachers endpoint to retrieve Teachers for a Class.

May 10, 2025

• Update V2 API with latest changes including V2P0 and V2P1 releases.

April 14, 2025

• Added PUT /v2/classes/:class_id/teachers endpoint to set Teacher memberships for a Class.

March 28, 2025

• Added PATCH /v2/students/:student_id/excusals/:id endpoint to update Attendance Excusal for a Student.

• Added DELETE /v2/students/:student_id/excusals/:id endpoint to delete Attendance Excusal for a Student.

March 14, 2025

• Added POST /v2/students/:student_id/excusals endpoint to create Attendance Excusal for a Student.

February 28, 2025

• Added GET /v2/students/excusals/:date endpoint to retrieve Attendance Excusals for a Date.

February 26, 2025

• Removed support of managing child_ids from request payload for /v2p1/parents endpoints

February 14, 2025

• Added GET /v2/students/:student_id/excusals endpoint to retrieve Attendance Excusals for a Student.

February 5, 2025

• Added attendance_categories details to /v2/year-groups/:year_group_id/homeroom/attendance/term/:term_id endpoint response

January 28, 2025

• Added category field to /v2/year-groups/:year_group_id/homeroom/attendance/date/:date endpoint response payload

January 25, 2025

• Added GET /v2/school/academic-years/:academic_year_id/attendance_categories endpoint to retrieve Attendance Categories for an Academic Year.

January 5, 2025

• Added GET /v2/year-groups/:year_group_id/homeroom/attendance/term/:term_id/adjustments endpoint to retrieve Year Group Attendance Adjustments for a reporting term.

• Changed id parameter to year_group_id for /v2/year-groups/:year_group_id/homeroom/attendance/term/:term_id and /v2/year-groups/:year_group_id/homeroom/attendance/date/:date endpoints.

December 12, 2024

• Added GET /v2/school/programs/:program/academic-years/:academic_year_id/calendar endpoint to retrieve Calendar for an Academic Year

November 6, 2024

• Added linked_to property to /v2/classes/:class_id/tasks and /v2/classes/:class_id/tasks/:id responses, that indicate the original class and task that the entity is a clone of.

October 17, 2024

• Added unenrolled_only filter to /v2/classes/:class_id/assessments/term/:term_id/term-grades endpoint

August 9, 2024

• Updated task_type of GET /v2/classes/:class_id/tasks

• Added task_type_name to GET /v2/classes/:class_id/tasks

July 19, 2024

• Added PUT /v2/students/:id/set_homeroom_attendance endpoint to set homeroom attendance for a student

June 20, 2024

• Changed per_page default and max limits to 10 students for /v2/classes/:class_id/assessments/term/:term_id/grades endpoint

April 29, 2024

• Added identifier to GET /v2/teachers, /v2/students, /v2/parents, /v2/teachers/:id, /v2/students/:id, /v2/parents/:id responses

• Added identifier parameter to POST /v2/teachers/:id, /v2/students/:id, /v2/parents/:id endpoints

• Added identifier parameter to PATCH /v2/teachers/:id, /v2/students/:id, /v2/parents/:id endpoints

April 26, 2024

• Added PUT /v2/teachers/:id/archive endpoint to archive a teacher

• Added PUT /v2/teachers/:id/unarchive endpoint to unarchive a teacher

March 20, 2024

• Added ui_language to GET /v2/teachers, /v2/students, /v2/parents, /v2/teachers/:id, /v2/students/:id, /v2/parents/:id responses

• Added ui_language parameter to POST /v2/teachers/:id, /v2/students/:id, /v2/parents/:id endpoints

• Added ui_language parameter to PATCH /v2/teachers/:id, /v2/students/:id, /v2/parents/:id endpoints

February 20, 2024

• Added student_ids filter to /v2/classes/:class_id/assessments/term/:term_id/term-grades endpoint

January 12, 2024

• Added year_group_ids filter to /v2/students endpoint

• Added homeroom_advisor_ids filter to /v2/students endpoint

November 28, 2023

• Added archived parameter to /v2/teachers and /v2/parents responses

November 9, 2023

• Added POST /v2/classes endpoint to create class

• Added PATCH /v2/classes/:id endpoint to update class

• Added PATCH /v2/classes endpoint to bulk create and update classes

October 31, 2023

• Added id, created_at, updated_at to /v2/behavior/notes response

• Added modified_since parameter to /v2/behavior/notes response to filter results by modification date

October 19, 2023

• Added author_id to /v2/behavior/notes response

October 16, 2023

• Added visible_to_parents and visible_to_students to /v2/behavior/notes response

October 11, 2023

• Added short_name to /v2/year_groups response

October 10, 2023

• Added phases option to /v2/memberships endpoint to return phases option of a membership

• Update level option of /v2/memberships endpoint to return levels option of a membership of different class types

September 25, 2023

• Added PATCH /v2/classes/:class_id/students endpoint to add/update class students with levels

September 11, 2023

• Added GET /v2/school/programs/:program/subjects endpoint to retrieve subjects

• Added GET /v2/school/programs/:program/subjects/:id endpoint to retrieve subject

• Added POST /v2/school/programs/:program/subjects endpoint to create subject for programs that support custom subjects

• Added PATCH /v2/school/programs/:program/subjects/:id endpoint to update subject for programs that support custom subjects

• Added DELETE /v2/school/programs/:program/subjects/:id endpoint to delete subject for programs that support custom subjects

• Added POST /v2/school/programs/:program/subjects/bulk-enable endpoint to bulk enable subjects

• Added POST /v2/school/programs/:program/subject/bulk-disable endpoint to bulk disable subjects

September 5, 2023

• The grades uid attribute from GET /v2/school/grades response has been deprecated and will be removed completely by the end of April 2024.

August 14, 2023

• Added session_in_may to /v2/school response

• programs from /v2/school response have been deprecated in favour of enabled_programs and will be removed completely by the end of April 2024. Please use enabled_programs instead.

July 11, 2023

• Added GET /v2/school/programs/:program/subject-groups/:id endpoint to retrieve subject group

• Added POST /v2/school/programs/:program/subject-groups endpoint to create subject group for programs that support custom subject groups

• Added PATCH /v2/school/programs/:program/subject-groups/:id endpoint to update subject group for programs that support custom subject groups

• Added DELETE /v2/school/programs/:program/subject-groups/:id endpoint to delete subject group for programs that support custom subject groups

June 30, 2023

• Added GET /v2/school/programs/:program/academic-years/:id endpoint to retrieve academic year

• Added POST /v2/school/programs/:program/academic-years endpoint to create academic year

• Added POST /v2/school/programs/:program/academic-years/:academic_year_id/academic-terms endpoint to create single academic term

• Added PATCH /v2/school/programs/:program/academic-years/:academic_year_id/academic-terms/:academic_term_id endpoint to update single academic term

• Added DELETE /v2/school/programs/:program/academic-years/:academic_year_id/academic-terms/:academic_term_id endpoint to delete single academic term

April 26, 2023

• Added due_date_extension_days & due_date to /classes/:class_id/assessments/term/:term_id/grades response

April 22, 2023

• Added /v2/school/term-rubrics endpoint to retrieve school term grade rubrics details

April 15, 2023

• Added /v2/school/term-grade-scales endpoint to retrieve school term grade scales for programs

October 5, 2022

• Added period_starts_count_from to /classes/:id/timetable response

• Added timetable section to /classes/:id/attendance/term/:term_id and /classes/:id/attendance/date/:date responses

July 5, 2022

• Added archived_students boolean param filter to /classes/:id/attendance/date/:date endpoint

• Added archived_students boolean param filter to /classes/:id/attendance/term/:term_id endpoint

• Added archived_students boolean param filter to /year-groups/:id/homeroom/attendance/date/:date endpoint

• Added archived_students boolean param filter to /year-groups/:yearGroupId/homeroom/attendance/term/:term_id endpoint

Apr 20, 2022

• Added /v2/teachers/:id/classes endpoint to retrieve teacher classes memberships

• Added /v2/teachers/:id/groups endpoint to retrieve teacher groups memberships

Apr 7, 2022

• Added user_ids filter to /v2/memberships endpoint

• Added class_happens_on filter to /v2/memberships endpoint

Apr 7, 2022

• Added /v2/students/:id/memberships endpoint to retrieve student memberships

Feb 26, 2022

• Added /v2/classes/:id/timetable endpoint to retrieve class timetable

Jan 19, 2022

• Added details to "Get Term Grades for a Class" API endpoint for IB Primary Class

Jan 18, 2022

• Added GET /v2/parents/:parent_id/children endpoint to retrieve parent-children relationships

• Added POST /v2/parents/:parent_id/children endpoint to create parent-child relationship

• Added PUT /v2/parents/:parent_id/children endpoint to bulk-update parent-children relationships

• Added GET /v2/parents/:parent_id/children/:id endpoint to retrieve single parent-child relationship

• Added PUT /v2/parents/:parent_id/children/:id endpoint to update single parent-child relationship

• Added DELETE /v2/parents/:parent_id/children/:id endpoint to delete single parent-child relationship

Apr 14, 2021

• Added status to students students?status=enrolled

Mar 17, 2021

• Added subject_option for the relevant DP and MYP subject groups (Language acquisition and Studies in language and literature) to the response of classes/:class-id/ and classes/

• Added /v2/behavior/notes endpoint to retrieve all available behaviour notes in the school

• Extended /v2/students endpoint to support retrieving only active or only archived students