Skip to main content
GET
List a collection

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

Query Parameters

limit
integer

Entities per page, a whole number from 1 to 1000. The default is 100.

offset
integer

How many entities to skip. The default is 0.

sort
string

The field to sort by.

Maximum string length: 60
orderBy
enum<string>

The sort order. The default is asc.

Available options:
asc,
desc
filter
string

OneRoster's filter, such as role='student', with =, !=, >, >=, <, <= or ~ (contains), joined by AND or OR (not both).

Maximum string length: 1000
fields
string

Only these fields, separated by commas.

Maximum string length: 1000

Response

The entities.

{key}
object[]