OneRoster API
sourcedId of the class to get categories of
GET /ims/oneroster/v1p1/sis/classes/{id}/categories HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Categories response
{
"categories": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"weight": 1
}
]
}
GET /ims/oneroster/v1p1/orgs HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Orgs response
{
"orgs": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"name": "text",
"type": "text",
"identifier": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
]
}
]
}
sourcedId of the org to get
GET /ims/oneroster/v1p1/orgs/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Org response
{
"org": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"name": "text",
"type": "text",
"identifier": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
]
}
}
GET /ims/oneroster/v1p1/schools HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Schools response
{
"orgs": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"name": "text",
"type": "text",
"identifier": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
]
}
]
}
sourcedId of the School to get
GET /ims/oneroster/v1p1/schools/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
School response
{
"org": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"name": "text",
"type": "text",
"identifier": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
]
}
}
GET /ims/oneroster/v1p1/enrollments HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Enrollments response
{
"enrollments": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"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-07-04",
"endDate": "2025-07-04"
}
]
}
sourcedId of the enrollment to get
GET /ims/oneroster/v1p1/enrollments/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Enrollment response
{
"enrollment": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"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-07-04",
"endDate": "2025-07-04"
}
}
GET /ims/oneroster/v1p1/terms HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Terms response
{
"academicSessions": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"startDate": "2025-07-04",
"endDate": "2025-07-04",
"type": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"schoolYear": "text"
}
]
}
sourcedId of the term to get
GET /ims/oneroster/v1p1/terms/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Term response
{
"academicSession": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"startDate": "2025-07-04",
"endDate": "2025-07-04",
"type": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"schoolYear": "text"
}
}
GET /ims/oneroster/v1p1/academicSession HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Academic session response
{
"academicSessions": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"startDate": "2025-07-04",
"endDate": "2025-07-04",
"type": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"schoolYear": "text"
}
]
}
sourcedId of the academic session to get
GET /ims/oneroster/v1p1/academicSession/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Academic session response
{
"academicSession": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"startDate": "2025-07-04",
"endDate": "2025-07-04",
"type": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"schoolYear": "text"
}
}
GET /ims/oneroster/v1p1/gradingPeriods HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Grading periods response
{
"academicSessions": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"startDate": "2025-07-04",
"endDate": "2025-07-04",
"type": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"schoolYear": "text"
}
]
}
sourcedId of the grading period to get
GET /ims/oneroster/v1p1/gradingPeriods/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Grading period response
{
"academicSession": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"startDate": "2025-07-04",
"endDate": "2025-07-04",
"type": "text",
"parent": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"children": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"schoolYear": "text"
}
}
GET /ims/oneroster/v1p1/courses HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Courses response
{
"courses": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"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"
}
]
}
]
}
sourcedId of the course to get
GET /ims/oneroster/v1p1/courses/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Courses response
{
"course": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"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"
}
]
}
}
GET /ims/oneroster/v1p1/classes HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Classes response
{
"classes": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"classCode": "text",
"classType": "text",
"location": "text",
"grades": [
"text"
],
"subjects": [
"text"
],
"course": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"school": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"terms": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"subjectCodes": [
"text"
],
"periods": [
"text"
],
"resources": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
]
}
]
}
sourcedId of the class to get
GET /ims/oneroster/v1p1/classes/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Class response
{
"class": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"title": "text",
"classCode": "text",
"classType": "text",
"location": "text",
"grades": [
"text"
],
"subjects": [
"text"
],
"course": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"school": {
"href": "text",
"sourcedId": "text",
"type": "text"
},
"terms": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"subjectCodes": [
"text"
],
"periods": [
"text"
],
"resources": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
]
}
}
GET /ims/oneroster/v1p1/users HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Users response
{
"users": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
]
}
sourcedId of the user to get
GET /ims/oneroster/v1p1/users/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
User response
{
"user": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
}
GET /ims/oneroster/v1p1/teachers HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Teachers response
{
"users": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
]
}
sourcedId of the teacher to get
GET /ims/oneroster/v1p1/teachers/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Teacher response
{
"user": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
}
sourcedId of the school to get teachers
GET /ims/oneroster/v1p1/schools/{schoolId}/teachers HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Teachers response
{
"users": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
]
}
GET /ims/oneroster/v1p1/students HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Students response
{
"users": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
]
}
sourcedId of the student to get
GET /ims/oneroster/v1p1/students/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Student response
{
"user": {
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
}
sourcedId of the school to get students
GET /ims/oneroster/v1p1/schools/{schoolId}/students HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Students response
{
"users": [
{
"sourcedId": "text",
"status": "text",
"dateLastModified": "2025-07-04T21:45:29.295Z",
"metadata": {},
"username": "text",
"userIds": [
{
"type": "text",
"identifier": "text"
}
],
"enabledUser": true,
"givenName": "text",
"familyName": "text",
"middleName": "text",
"role": "text",
"identifier": "text",
"email": "text",
"sms": "text",
"phone": "text",
"agents": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"orgs": [
{
"href": "text",
"sourcedId": "text",
"type": "text"
}
],
"grades": [
"text"
],
"password": "text"
}
]
}
Last updated
Was this helpful?