Community

OneRoster API

Return collection of categories for the given class.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the class to get categories of

Responses
200
Categories response
application/json
get
GET /ims/oneroster/v1p1/sis/classes/{id}/categories HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Categories response

{
  "categories": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "metadata": {},
      "title": "text",
      "weight": 1
    }
  ]
}

Return collection of orgs.

get
Authorizations
Responses
200
Orgs response
application/json
get
GET /ims/oneroster/v1p1/orgs HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Orgs response

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "metadata": {},
      "name": "text",
      "type": "text",
      "identifier": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Return specific org.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the org to get

Responses
200
Org response
application/json
get
GET /ims/oneroster/v1p1/orgs/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Org response

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "metadata": {},
    "name": "text",
    "type": "text",
    "identifier": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Return collection of Schools. A School is an instance of an Org.

get
Authorizations
Responses
200
Schools response
application/json
get
GET /ims/oneroster/v1p1/schools HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Schools response

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "metadata": {},
      "name": "text",
      "type": "text",
      "identifier": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Return specific School. A School is an instance of an Org.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the School to get

Responses
200
School response
application/json
get
GET /ims/oneroster/v1p1/schools/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

School response

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "metadata": {},
    "name": "text",
    "type": "text",
    "identifier": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Return collection of enrollments.

get
Authorizations
Responses
200
Enrollments response
application/json
get
GET /ims/oneroster/v1p1/enrollments HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Enrollments response

{
  "enrollments": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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-18",
      "endDate": "2025-07-18"
    }
  ]
}

Return specific enrollment.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the enrollment to get

Responses
200
Enrollment response
application/json
get
GET /ims/oneroster/v1p1/enrollments/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Enrollment response

{
  "enrollment": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "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-18",
    "endDate": "2025-07-18"
  }
}

Return collection of terms. A Term is an instance of an AcademicSession.

get
Authorizations
Responses
200
Terms response
application/json
get
GET /ims/oneroster/v1p1/terms HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Terms response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-07-18",
      "endDate": "2025-07-18",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Return specific term. A Term is an instance of an AcademicSession.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the term to get

Responses
200
Term response
application/json
get
GET /ims/oneroster/v1p1/terms/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Term response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-07-18",
    "endDate": "2025-07-18",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Return collection of all academic sessions.

get
Authorizations
Responses
200
Academic session response
application/json
get
GET /ims/oneroster/v1p1/academicSession HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Academic session response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-07-18",
      "endDate": "2025-07-18",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Return specific academic session.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the academic session to get

Responses
200
Academic session response
application/json
get
GET /ims/oneroster/v1p1/academicSession/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Academic session response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-07-18",
    "endDate": "2025-07-18",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Return collection of grading periods. A grading period is an instance of an AcademicSession.

get
Authorizations
Responses
200
Grading periods response
application/json
get
GET /ims/oneroster/v1p1/gradingPeriods HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Grading periods response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-07-18",
      "endDate": "2025-07-18",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Return specific grading period. A grading period is an instance of an academic session.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the grading period to get

Responses
200
Grading period response
application/json
get
GET /ims/oneroster/v1p1/gradingPeriods/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Grading period response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-07-18",
    "endDate": "2025-07-18",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Return collection of courses.

get
Authorizations
Responses
200
Courses response
application/json
get
GET /ims/oneroster/v1p1/courses HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Courses response

{
  "courses": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
        }
      ]
    }
  ]
}

Return specific course.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the course to get

Responses
200
Courses response
application/json
get
GET /ims/oneroster/v1p1/courses/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Courses response

{
  "course": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "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"
      }
    ]
  }
}

Return collection of classes.

get
Authorizations
Responses
200
Classes response
application/json
get
GET /ims/oneroster/v1p1/classes HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Classes response

{
  "classes": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
        }
      ]
    }
  ]
}

Return specific class.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the class to get

Responses
200
Class response
application/json
get
GET /ims/oneroster/v1p1/classes/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Class response

{
  "class": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "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"
      }
    ]
  }
}

Return collection of users.

get
Authorizations
Responses
200
Users response
application/json
get
GET /ims/oneroster/v1p1/users HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Users response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
    }
  ]
}

Return specific user.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the user to get

Responses
200
User response
application/json
get
GET /ims/oneroster/v1p1/users/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

User response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "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"
  }
}

Return collection of teachers. A teacher is an instance of a user.

get
Authorizations
Responses
200
Teachers response
application/json
get
GET /ims/oneroster/v1p1/teachers HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Teachers response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
    }
  ]
}

Return specific teacher. A teacher is an instance of a user.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the teacher to get

Responses
200
Teacher response
application/json
get
GET /ims/oneroster/v1p1/teachers/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Teacher response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "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"
  }
}

Return the collection of teachers teaching at this school.

get
Authorizations
Path parameters
schoolIdstringRequired

sourcedId of the school to get teachers

Responses
200
Teachers response
application/json
get
GET /ims/oneroster/v1p1/schools/{schoolId}/teachers HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Teachers response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
    }
  ]
}

Return collection of students. A student is an instance of a user.

get
Authorizations
Responses
200
Students response
application/json
get
GET /ims/oneroster/v1p1/students HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Students response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
    }
  ]
}

Return specific student. A student is an instance of a user.

get
Authorizations
Path parameters
idstringRequired

sourcedId of the student to get

Responses
200
Student response
application/json
get
GET /ims/oneroster/v1p1/students/{id} HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Student response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-07-18T04:00:48.587Z",
    "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"
  }
}

Return the collection of students attending this school.

get
Authorizations
Path parameters
schoolIdstringRequired

sourcedId of the school to get students

Responses
200
Students response
application/json
get
GET /ims/oneroster/v1p1/schools/{schoolId}/students HTTP/1.1
Host: oneroster.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Students response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-07-18T04:00:48.587Z",
      "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"
    }
  ]
}
PreviousGrades Exchange APINextPlatform API

Last updated

Was this helpful?