cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Rostering Service Configurations

Find your school's Canvas URL

To find your school or institution's Canvas URL, begin typing the name of your school/institution. Results will appear after you type at least 3 characters. For best results be as specific as possible. If you can't find your school, try using any part of your school's name or searching for your school district or state. You may also need to search for the school using the acronym or full name, for example "USU" and "Utah State University".

Rostering Service Configurations

Instructure provisions rostering data using two rostering services. Configure your integration to support both service methods. Additionally, review the rostering best practices.

Note: All payloads are expected to pass IMS global validator. Learn more about OneRoster REST service certification.

Note: Instructure is a OneRoster Consumer. For OneRoster Consumer and Provider definitions, view the Introduction to OneRoster.

Bulk Rostering Service

 

Service Call Endpoint HTTP Verb Required
getAllClasses
/classes GET
getAllCourses
/courses GET
getAllDemographics
/demographics GET 𝗫
getAllEnrollments
/enrollments GET
getAllOrgs
/orgs GET
getAllSchools
/schools GET
getAllStudents
/students GET
getAllTeachers
/teachers GET
getAllUsers
/users GET
getAllTerms
/terms GET
getAllAcademicSessions
/academicSessions GET
getAllGradingPeriods
/gradingPeriods GET

School Specific Rostering Service

 

Service Call Endpoint HTTP Verb Required
getCoursesForSchool
/schools/{id}/courses GET
getEnrollmentsForSchool
/schools/{school_id}/enrollments GET
getStudentsForSchool
/schools/{school_id}/students GET
getTeachersForSchool
/schools/{school_id}/teachers GET
getTermsForSchool
/schools/{school_id}/terms GET
getAllAcademicSessions
/academicSessions GET
getAllGradingPeriods
/gradingPeriods GET
getAllOrgs /orgs GET
getAllSchools /schools GET
Have a question about SIS? Ask in the Q&A forum:
Embed this guide in your Canvas course:

Note: You can only embed guides in Canvas courses. Embedding on other sites is not supported.