Skip to main content
The Scout API gives approved partners and districts programmatic, read access to rostering data and a small set of related write endpoints. The roster surface implements the IMS OneRoster 1.1 and 1.2 REST bindings.

​
Base URL

All requests are made against:
For example, the OneRoster 1.1 students endpoint is https://api.teachwithscout.com/v1/ims/oneroster/v1p1/students.

​
Conventions

  • All responses are JSON.
  • Collection endpoints support limit, offset, sort, orderBy, and filter query parameters, and return RFC 5988 pagination links in the Link header.
  • Timestamps are ISO 8601.

​
Getting access

API credentials (a client_id and client_secret) are issued per district by Scout. Reach out to your Scout contact to request access. Once you have credentials, see Authentication to mint an access token, then explore the endpoints in this section.