OneRoster API

Modified on Wed, Sep 20, 2023 at 10:25 AM

OneRoster API


URLs are per district, will look like this:

Token endpoint: /token

API endpoint: /ims/oneroster/v1p1/

OneRoster Specs:

Metadata Fields:


    - preferredForename

    - preferredSurname

    - registrationGroup

    - religion

    - firstLanguage

    - homeAddress

    - classification

    - medicalConditions

    - sibling (+ sibling number)

    - studentPhoto (optional)

    - attendanceDaysTotal

    - attendancePresent

    - attendanceExcusedAbsence

    - attendanceUnexcusedAbsence


    - preferredForename

    - preferredSurname

    - homeAddress

NOTE:  Staff require an email address in order to be synced into many applications such as Canvas

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article