OpenRoster API

API explorer

Get a tenant-scoped OAuth token, choose a role lens, inspect the OneRoster endpoint, then run live requests through the secure OpenRoster request broker.

OpenAPI reference Download spec

Live API explorer

Tenant-scoped OneRoster requests

Use your app credentials to obtain an OAuth client-credentials token, then run grant-aware GET requests through OpenRoster’s server-side request broker.

No browser storage

Tenant

API base URL Tenant ID

Role lens

Scopes

Roster core Organizations, users, courses, classes, enrollments, and academic sessions. Roster relationships Contextual class, school, course, student, teacher, and term relationship endpoints. Demographics Sensitive student demographics, separated so districts can approve it deliberately. Resource core 1EdTech Resource Service read access for learning-resource metadata. Gradebook core 1EdTech Gradebook Service read access for categories, line items, and results.

Vendor app: core roster

Endpoint

10 endpoints match selected scopes

GET /orgs

District, school, and department organizations visible through the active grant.

Scope selected

roster-core.readonlyroster.readonly

Query parameters

Limit Offset Filter Fields Sort Order

Request

curl --request GET 'https://api.openroster.org/ims/oneroster/rostering/v1p2/orgs?limit=10&offset=0' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <access_token>'

https://api.openroster.org/ims/oneroster/rostering/v1p2/orgs?limit=10&offset=0

Response

Run a request to see status, timing, headers, and body.

OpenAPI reference

1EdTech OneRoster 1.2 endpoints

Download JSON