Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • API Reference
        • Captions
        • Collection
        • Courses
        • Group
        • Insights
        • Media
        • Media Upload
        • Ping
        • Professional Captioning
        • Tags
        • Transfer Media
        • User
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page

Was this helpful?

  1. Services
  2. DataSync

OneRoster API

PreviousGrades Exchange APINextPlatform API

Last updated 1 year ago

Was this helpful?

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
Accept: */*
200

Orgs response

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

Org response

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Schools response

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

School response

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Enrollments response

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

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
Accept: */*
200

Enrollment response

{
  "enrollment": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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-05-25",
    "endDate": "2025-05-25"
  }
}

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
Accept: */*
200

Terms response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-05-25",
      "endDate": "2025-05-25",
      "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
Accept: */*
200

Term response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-05-25",
    "endDate": "2025-05-25",
    "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
Accept: */*
200

Academic session response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-05-25",
      "endDate": "2025-05-25",
      "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
Accept: */*
200

Academic session response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-05-25",
    "endDate": "2025-05-25",
    "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
Accept: */*
200

Grading periods response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "metadata": {},
      "title": "text",
      "startDate": "2025-05-25",
      "endDate": "2025-05-25",
      "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
Accept: */*
200

Grading period response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "metadata": {},
    "title": "text",
    "startDate": "2025-05-25",
    "endDate": "2025-05-25",
    "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
Accept: */*
200

Courses response

{
  "courses": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

Courses response

{
  "course": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Classes response

{
  "classes": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

Class response

{
  "class": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Users response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

User response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Teachers response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

Teacher response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Teachers response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

Students response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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
Accept: */*
200

Student response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2025-05-25T21:19:11.100Z",
    "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
Accept: */*
200

Students response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2025-05-25T21:19:11.100Z",
      "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"
    }
  ]
}
  • GETReturn collection of orgs.
  • GETReturn specific org.
  • GETReturn collection of Schools. A School is an instance of an Org.
  • GETReturn specific School. A School is an instance of an Org.
  • GETReturn collection of enrollments.
  • GETReturn specific enrollment.
  • GETReturn collection of terms. A Term is an instance of an AcademicSession.
  • GETReturn specific term. A Term is an instance of an AcademicSession.
  • GETReturn collection of all academic sessions.
  • GETReturn specific academic session.
  • GETReturn collection of grading periods. A grading period is an instance of an AcademicSession.
  • GETReturn specific grading period. A grading period is an instance of an academic session.
  • GETReturn collection of courses.
  • GETReturn specific course.
  • GETReturn collection of classes.
  • GETReturn specific class.
  • GETReturn collection of users.
  • GETReturn specific user.
  • GETReturn collection of teachers. A teacher is an instance of a user.
  • GETReturn specific teacher. A teacher is an instance of a user.
  • GETReturn the collection of teachers teaching at this school.
  • GETReturn collection of students. A student is an instance of a user.
  • GETReturn specific student. A student is an instance of a user.
  • GETReturn the collection of students attending this school.