Instructure Developer Documentation Portal

OneRoster API

PreviousGrades Exchange API NextPlatform API

Last updated 1 year ago

Was this helpful?

Return collection of orgs.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs'

200

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "metadata": {},
      "name": "text",
      "type": "text",
      "identifier": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Orgs response

Return specific org.

get

Authorizations

Path parameters

idstringrequired

sourcedId of the org to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs/{id}'

200

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "metadata": {},
    "name": "text",
    "type": "text",
    "identifier": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Org response

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools'

200

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "metadata": {},
      "name": "text",
      "type": "text",
      "identifier": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Schools response

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

get

Authorizations

Path parameters

idstringrequired

sourcedId of the School to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{id}'

200

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "metadata": {},
    "name": "text",
    "type": "text",
    "identifier": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

School response

Return collection of enrollments.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments'

200

{
  "enrollments": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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-03-25",
      "endDate": "2025-03-25"
    }
  ]
}

Enrollments response

Return specific enrollment.

get

Authorizations

Path parameters

idstringrequired

sourcedId of the enrollment to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments/{id}'

200

{
  "enrollment": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "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-03-25",
    "endDate": "2025-03-25"
  }
}

Enrollment response

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms'

200

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-03-25",
      "endDate": "2025-03-25",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Terms response

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

get

Authorizations

Path parameters

idstringrequired

sourcedId of the term to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms/{id}'

200

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-03-25",
    "endDate": "2025-03-25",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Term response

Return collection of all academic sessions.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession'

200

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-03-25",
      "endDate": "2025-03-25",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Academic session response

Return specific academic session.

get

Authorizations

Path parameters

idstringrequired

sourcedId of the academic session to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession/{id}'

200

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-03-25",
    "endDate": "2025-03-25",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Academic session response

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods'

200

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-03-25",
      "endDate": "2025-03-25",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Grading periods response

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods/{id}'

200

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-03-25",
    "endDate": "2025-03-25",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Grading period response

Return collection of courses.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses'

200

{
  "courses": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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 response

Return specific course.

get

Authorizations

Path parameters

idstringrequired

sourcedId of the course to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses/{id}'

200

{
  "course": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "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 response

Return collection of classes.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes'

200

{
  "classes": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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"
        }
      ]
    }
  ]
}

Classes response

Return specific class.

get

Authorizations

Path parameters

idstringrequired

sourcedId of the class to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes/{id}'

200

{
  "class": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "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"
      }
    ]
  }
}

Class response

Return collection of users.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users'

200

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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"
    }
  ]
}

Users response

Return specific user.

get

Authorizations

Path parameters

idstringrequired

sourcedId of the user to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users/{id}'

200

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "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"
  }
}

User response

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers'

200

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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"
    }
  ]
}

Teachers response

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

get

Authorizations

Path parameters

idstringrequired

sourcedId of the teacher to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers/{id}'

200

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "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"
  }
}

Teacher response

Return the collection of teachers teaching at this school.

get

Authorizations

Path parameters

schoolIdstringrequired

sourcedId of the school to get teachers

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/teachers'

200

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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"
    }
  ]
}

Teachers response

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students'

200

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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"
    }
  ]
}

Students response

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

get

Authorizations

Path parameters

idstringrequired

sourcedId of the student to get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students/{id}'

200

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-03-25T21:33:33.469Z",
    "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"
  }
}

Student response

Return the collection of students attending this school.

get

Authorizations

Path parameters

schoolIdstringrequired

sourcedId of the school to get students

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/students'

200

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-03-25T21:33:33.469Z",
      "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"
    }
  ]
}

Students response