Skip to main content
The API reads a school’s students, contacts, staff, classes and payments. It is read-only, and returns JSON.

Base URL

A school administrator copies it, with the key, from Copy Your API Key on the API’s page.

Authentication

Send one of the school’s API keys as a bearer token with every request:
Each key reads only the resources the school chose for it, such as students:read. See API keys. OneRoster uses an access token instead, from Create an access token.

Lists and paging

Lists return data, total, limit and offset, oldest change first. Pass the latest updatedAt you have read as updatedSince to read only what changed. See Paging and changes.

Errors

A refused request answers with its HTTP status and a body whose statusMessage says what went wrong.

Webhooks

Webhooks post an event when a record changes. Each event’s page shows what it sends. See Webhooks to add one and Verify signatures to check them.