Intellischool Python API Docs | dltHub
Build a Intellischool-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Intellischool's OneRoster v1.1 API allows access to classes, courses, and enrollments via RESTful endpoints. Authorization requires a bearer token. The API supports managing educational resources and enrollments. The REST API base URL is https://api.intellischool.net/ims/oneroster/v1p1 and All requests require an OAuth2 Bearer access token (Client Credentials grant)..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Intellischool data in under 10 minutes.
What data can I load from Intellischool?
Here are some of the endpoints you can load from Intellischool:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| academic_sessions | /academicSessions | GET | academicSessions | list or single academic session(s) |
| classes | /classes | GET | classes | list or single class(es) |
| courses | /courses | GET | courses | list or single course(s) |
| enrollments | /enrollments | GET | enrollments | list or single enrolment(s) |
| grading_periods | /gradingPeriods | GET | gradingPeriods | list or single grading period(s) |
| orgs | /orgs | GET | orgs | organisations or single org |
| schools | /schools | GET | schools | list or single school(s) |
| students | /students | GET | students | list or single student(s) |
| teachers | /teachers | GET | teachers | list or single teacher/staff(s) |
| terms | /terms | GET | terms | list or single term(s) |
| users | /users | GET | users | list or single user(s) |
| courses/{id}/classes | /courses/{id}/classes | GET | classes | classes for a course |
| classes/{id}/students | /classes/{id}/students | GET | students | students in a class |
| schools/{school_id}/classes/{class_id}/enrollments | /schools/{school_id}/classes/{class_id}/enrollments | GET | enrollments | enrolments for class in school |
How do I authenticate with the Intellischool API?
Clients obtain an OAuth2 access token using the Client Credentials grant and include it in requests with the header Authorization: Bearer {token}.
1. Get your credentials
- Sign in to the IntelliSchool developer/admin portal for your organization or contact IntelliSchool to request API client credentials.
- Register a new OAuth2 client using the Client Credentials grant and request the required OneRoster scopes (e.g., roster-core.readonly).
- Record the client ID and client secret.
- Exchange the client ID and secret at the token endpoint (
https://api.intellischool.net/token) withgrant_type=client_credentialsand the desired scopes to receive anaccess_token. - Use the obtained token in the
Authorization: Bearer {access_token}header for all API calls.
2. Add them to .dlt/secrets.toml
[sources.intellischool_oneroster_source] client_id = "your_client_id_here" client_secret = "your_client_secret_here" token_url = "https://api.intellischool.net/token"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Intellischool API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python intellischool_oneroster_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline intellischool_oneroster_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset intellischool_oneroster_data The duckdb destination used duckdb:/intellischool_oneroster.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline intellischool_oneroster_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads students and classes from the Intellischool API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def intellischool_oneroster_source(client_credentials=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.intellischool.net/ims/oneroster/v1p1", "auth": { "type": "bearer", "access_token": client_credentials, }, }, "resources": [ {"name": "students", "endpoint": {"path": "students", "data_selector": "students"}}, {"name": "classes", "endpoint": {"path": "classes", "data_selector": "classes"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="intellischool_oneroster_pipeline", destination="duckdb", dataset_name="intellischool_oneroster_data", ) load_info = pipeline.run(intellischool_oneroster_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("intellischool_oneroster_pipeline").dataset() sessions_df = data.students.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM intellischool_oneroster_data.students LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("intellischool_oneroster_pipeline").dataset() data.students.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Intellischool data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Intellischool?
Request dlt skills, commands, AGENT.md files, and AI-native context.