Skip to main content

OneRoster API Guide

This guide walks you through setting up OneRoster API for your SIS and TadHealth integration.

Written by Jareena

What Is OneRoster API Sync?

OneRoster API Sync allows school districts to automatically "pull" data into TadHealth on a regular schedule. Districts connect their SIS (Student Information System) to TadHealth using the OneRoster API, an industry-standard format for exchanging school roster data. Once connected, TadHealth securely retrieves student, staff, and class data directly from your SIS — no manual file uploads required.

Before you begin: We recommend confirming with your SIS vendor that OneRoster API access is enabled for your district before starting setup.

What You'll Need

At minimum, you'll need to enable read permissions to the following items in your SIS's OneRoster API:

  • Student Data / Student Data

  • School Information / Schools

  • School Information / Terms

  • Scheduling / Teacher Data

  • Scheduling / Master Schedule

  • Scheduling / Course Data

  • Scheduling / Classes

Once those permissions are enabled, you'll enter the following connection details into the TadHealth Superuser Portal:

  • OneRoster base URL

  • Consumer ID

  • Consumer Secret Key (if applicable)

You can save this information and test the connection immediately from the Superuser Portal.

Note for Infinite Campus districts: If you're using Infinite Campus, remove /ims/oneroster/v1p1 from the base URL when copying it over. TadHealth automatically appends this when making API calls.

Setting Up OneRoster for Aeries

If you use Aeries, please follow this Aeries guide to set up OneRoster with your SIS.

Entering Your Credentials in TadHealth

Once you have your OneRoster URL, Consumer ID, and Consumer Secret Key, enter them into the TadHealth Superuser Portal at:

*Please note that the URL above is unique to your organization. If you are unaware of what your organization's shortcode is please contact us as [email protected]

After entering your connection details, you can save and test the connection directly from the portal to confirm everything is working.

Need Help?

If you run into any issues during setup — or you're using a different SIS and aren't sure where to find these settings — reach out to the TadHealth support team at [email protected] and we'll be glad to help.

Did this answer your question?