> ## Documentation Index
> Fetch the complete documentation index at: https://dev.schoolcues.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OneRoster 1.1

> Give roster tools the school's classes, teachers, students and enrollments through OneRoster's REST API.

OneRoster is off until a school administrator turns it on in [**Settings › Integrations › OneRoster**](https://portal.schoolcues.com/settings/integrations/oneroster).

## Credentials

On OneRoster's page, the administrator creates credentials for each tool: a name, a client ID that starts with `sc_`, and a secret shown once.

The tool trades them for an access token that lasts an hour, sending them as HTTP Basic authentication or in the form body:

```bash theme={null}
curl -X POST https://BASE_URL/oauth/token \
  -u "sc_CLIENT_ID:SECRET" \
  -d grant_type=client_credentials
```

Deleting a tool's credentials, or turning OneRoster off, stops the tool at its next request.

## Collections

Read the roster at `/ims/oneroster/v1p1/{collection}` and `/ims/oneroster/v1p1/{collection}/{sourcedId}`:

`orgs`, `schools`, `academicSessions`, `terms`, `courses`, `classes`, `users`, `students`, `teachers` and `enrollments`.

Lists take OneRoster's `limit`, `offset`, `sort`, `orderBy`, `fields` and `filter` (with `AND` or `OR`), and return the total in `X-Total-Count`.

## What's in the roster

The organization and school, the current school year and its terms, a course per class, the year's active classes, active students with their school email addresses, teachers assigned to a class, and current enrollments. It holds no families, no contact details beyond school email, and nothing from a student's record.

A tool that takes a file instead can use **Download Roster**, a zip of OneRoster's CSV files.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.