Please note that this article is for reference for API integrators, not to be used by schools. Schools should use our guidance here.
Scope |
Endpoints |
Notes |
|---|---|---|
|
contacts:first-party |
/contacts/ |
This scope shows additional contacts in this endpoint based on the contact’s “allow contact by first/third party” settings in ScholarPack. |
|
contacts:third-party |
/contacts/ |
This scope is required to access this endpoint. |
|
former-student-register:read |
/students/register/historic/ |
|
|
lac:read |
/students/lac/ |
|
|
school-info:read |
/school/ |
|
|
sen:read |
/students/sen/ |
|
|
staff-contract:read |
/staff/contracts/ |
|
|
staff-email:write |
/staff/email/ |
|
| staff-photo:read |
/staff/<string:staff_uuid>/photos/ |
|
|
staff-register:read |
/staff/register/ /staff/absences/ |
|
|
staff-register:write |
/staff/register/ |
|
|
staff:read |
/staff/ |
|
|
staff-swipe:write |
/staff/swipe/ |
|
|
statutory-assessment:read |
/students/assessment/statutory/ |
|
|
student-assessment:read |
/students/assessments/filters/ /students/assessments/<string:assessment_uuid>/marks/ /students/assessment/steps/ /students/assessment/steps/checkpoints/ /students/assessment/statutory/checkpoints/ /students/assessment/early_years/checkpoints/ /students/assessment/early_years/ /students/assessment/simple/ /students/assessment/simple/<string:assessment_uuid>/marks/ /students/assessment/simple/checkpoints/ |
|
|
student-email:write |
/students/email/ |
|
|
student-exclusion:read |
/students/exclusions/ |
|
|
student-meal:read |
/meals/ /students/meals/ |
|
|
student-photo:read |
/students/<string:student_uuid>/photos/ |
|
|
student-register:read |
/students/register/ |
|
|
student:read |
/students/ |
|
|
student-register:write |
/students/register/ |
|
|
student-custom-fields:read |
/custom_fields/students/, /students/custom_fields/ |
|
|
staff-custom-fields:read |
/custom_fields/staff/, /staff/custom_fields/ |
|