Skip to main content
GET
Retrieve an entity

Authorizations

Authorization
string
header
required

An access token from Create an access token.

Path Parameters

collection
enum<string>
required

The collection. schools, terms, students and teachers are OneRoster’s views of orgs, academicSessions and users.

Available options:
orgs,
schools,
academicSessions,
terms,
courses,
classes,
users,
students,
teachers,
enrollments
sourcedId
string
required

The entity’s sourced ID.

Query Parameters

fields
string

Only these fields, separated by commas.

Maximum string length: 1000

Response

The entity.

{key}
object

A OneRoster 1.1 entity, as the OneRoster specification defines it.