Please note that this article is for reference for API integrators, not to be used by schools. Schools should use our guidance here.
Read only scopes - these provide read-only access to school data.
- student:read
- student-exclusion:read
- student-register:read
- student-attendance:read
- student-photo:read
- sen:read
- lac:read
- student-register-attendance:read
- student-register-history:read
- statutory-assessment:read
- former-student-register:read
- contacts:first-party
- contacts:third-party
- staff:read
- staff-contract:read
- staff-register:read
- school-info:read
Write only scopes - these provide write access to specific school data.
- student-register:write
- staff-register:write