Authentication

The Scout API uses the OAuth 2.0 client credentials grant. You exchange a client_id / client_secret pair for a short-lived bearer token, then send that token on every request.

Get your credentials

Scout issues a client_id and client_secret per district. Contact your Scout representative to request them. Treat the secret like a password.

Request an access token

POST to the token endpoint with grant_type=client_credentials. You can pass the credentials either via HTTP Basic auth or in the form body.

curl -X POST https://api.teachwithscout.com/v1/ims/oneroster/v1p1/token \
  -u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials"

The response contains your token:

{
  "access_token": "eyJhbGciOi...",
  "token_type": "bearer",
  "expires_in": 3600
}

Call the API

Send the token in the Authorization header as a bearer token.

curl https://api.teachwithscout.com/v1/ims/oneroster/v1p1/students \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Access tokens expire after 1 hour (expires_in: 3600). Request a new token when the current one expires. OneRoster 1.2 clients should use the /ims/oneroster/v1p2/token endpoint instead.

Get enrollment invitations

⌘I

Get started

Endpoints

Authentication