Last updated 11 months ago
Was this helpful?
/orgs
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs'
{ "orgs": [ { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "name": "text", "type": "text", "identifier": "text", "parent": { "href": "text", "sourcedId": "text", "type": "text" }, "children": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } ] }
/orgs/{id}
sourcedId of the org to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs/{id}'
{ "org": { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "name": "text", "type": "text", "identifier": "text", "parent": { "href": "text", "sourcedId": "text", "type": "text" }, "children": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } }
/schools
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools'
/schools/{id}
sourcedId of the School to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{id}'
/enrollments
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments'
{ "enrollments": [ { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "user": { "href": "text", "sourcedId": "text", "type": "text" }, "class": { "href": "text", "sourcedId": "text", "type": "text" }, "school": { "href": "text", "sourcedId": "text", "type": "text" }, "role": "text", "primary": true, "beginDate": "2025-02-20", "endDate": "2025-02-20" } ] }
/enrollments/{id}
sourcedId of the enrollment to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments/{id}'
{ "enrollment": { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "user": { "href": "text", "sourcedId": "text", "type": "text" }, "class": { "href": "text", "sourcedId": "text", "type": "text" }, "school": { "href": "text", "sourcedId": "text", "type": "text" }, "role": "text", "primary": true, "beginDate": "2025-02-20", "endDate": "2025-02-20" } }
/terms
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms'
{ "academicSessions": [ { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "title": "text", "startDate": "2025-02-20", "endDate": "2025-02-20", "type": "text", "parent": { "href": "text", "sourcedId": "text", "type": "text" }, "schoolYear": "text", "children": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } ] }
/terms/{id}
sourcedId of the term to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms/{id}'
{ "academicSession": { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "title": "text", "startDate": "2025-02-20", "endDate": "2025-02-20", "type": "text", "parent": { "href": "text", "sourcedId": "text", "type": "text" }, "schoolYear": "text", "children": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } }
/academicSession
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession'
/academicSession/{id}
sourcedId of the academic session to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession/{id}'
/gradingPeriods
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods'
/gradingPeriods/{id}
sourcedId of the grading period to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods/{id}'
/courses
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses'
{ "courses": [ { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "title": "text", "schoolYear": { "href": "text", "sourcedId": "text", "type": "text" }, "courseCode": "text", "grades": [ "text" ], "subjects": [ "text" ], "subjectCodes": [ "text" ], "resources": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } ] }
/courses/{id}
sourcedId of the course to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses/{id}'
{ "course": { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "title": "text", "schoolYear": { "href": "text", "sourcedId": "text", "type": "text" }, "courseCode": "text", "grades": [ "text" ], "subjects": [ "text" ], "subjectCodes": [ "text" ], "resources": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } }
/classes
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes'
{ "classes": [ { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "title": "text", "classCode": "text", "classType": "text", "location": "text", "course": { "href": "text", "sourcedId": "text", "type": "text" }, "school": { "href": "text", "sourcedId": "text", "type": "text" }, "grades": [ "text" ], "subjects": [ "text" ], "terms": [ { "href": "text", "sourcedId": "text", "type": "text" } ], "subjectCodes": [ "text" ], "periods": [ "text" ], "resources": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } ] }
/classes/{id}
sourcedId of the class to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes/{id}'
{ "class": { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "title": "text", "classCode": "text", "classType": "text", "location": "text", "course": { "href": "text", "sourcedId": "text", "type": "text" }, "school": { "href": "text", "sourcedId": "text", "type": "text" }, "grades": [ "text" ], "subjects": [ "text" ], "terms": [ { "href": "text", "sourcedId": "text", "type": "text" } ], "subjectCodes": [ "text" ], "periods": [ "text" ], "resources": [ { "href": "text", "sourcedId": "text", "type": "text" } ] } }
/users
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users'
{ "users": [ { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "username": "text", "enabledUser": true, "givenName": "text", "familyName": "text", "middleName": "text", "role": "text", "identifier": "text", "email": "text", "sms": "text", "phone": "text", "password": "text", "userIds": [ { "type": "text", "identifier": "text" } ], "agents": [ { "href": "text", "sourcedId": "text", "type": "text" } ], "orgs": [ { "href": "text", "sourcedId": "text", "type": "text" } ], "grades": [ "text" ] } ] }
/users/{id}
sourcedId of the user to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users/{id}'
{ "user": { "sourcedId": "text", "status": "text", "dateLastModified": "2025-02-20T18:48:56.126Z", "metadata": {}, "username": "text", "enabledUser": true, "givenName": "text", "familyName": "text", "middleName": "text", "role": "text", "identifier": "text", "email": "text", "sms": "text", "phone": "text", "password": "text", "userIds": [ { "type": "text", "identifier": "text" } ], "agents": [ { "href": "text", "sourcedId": "text", "type": "text" } ], "orgs": [ { "href": "text", "sourcedId": "text", "type": "text" } ], "grades": [ "text" ] } }
/teachers
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers'
/teachers/{id}
sourcedId of the teacher to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers/{id}'
/schools/{schoolId}/teachers
sourcedId of the school to get teachers
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/teachers'
/students
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students'
/students/{id}
sourcedId of the student to get
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students/{id}'
/schools/{schoolId}/students
sourcedId of the school to get students
curl -L \ --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/students'