API Reference

Timeback provides eight 1EdTech-compliant APIs that work together to power educational applications. This reference documents each API’s endpoints, data models, and use cases.

The APIs

API	Purpose
OneRoster	Manage courses, rosters, enrollments, and assessment results
EduBridge	Simplified resource management and pre-aggregated analytics
Caliper	Track learning sessions, activity events, and calculate XP
QTI	Create, deliver, and score digital assessments
PowerPath	Adaptive quizzes, placement tests, and mastery progression
CASE	Align content to academic standards (CCSS, NGSS, state frameworks)
Open Badges	Issue and verify digital credentials
CLR	Comprehensive learner records aggregating achievements

Core APIs: OneRoster + Caliper

Most integrations use OneRoster and Caliper together. These two APIs handle the majority of educational data flows.

OneRoster
Caliper

What OneRoster Manages

Resource	Purpose
Courses	What content exists (“Math Grade 5”)
Classes	Specific offerings of a course
Students	Who uses your app
Enrollments	Who can access what
Resources	Learning materials (videos, quizzes)
AssessmentResults	Scores and XP earned

Use OneRoster when you need to structure educational content, manage student enrollments, or store assessment results.

What Caliper Tracks

Event Type	Purpose
ActivityEvent	Started/completed activities with scores
TimeSpentEvent	Active vs inactive learning time

Use Caliper when you need to track student activity, measure learning time, or build analytics dashboards.

How They Work Together

Create course structure

Use OneRoster to create a course, add components (units/lessons), and attach resources.

Enroll students

Use OneRoster (or EduBridge) to enroll students in the course, giving them access to content.

Track learning

Use Caliper to track when students start and complete activities in real-time.

Store results

Use OneRoster to store final scores, XP, and mastery data in assessment results.

Additional APIs

EduBridge

Convenience layer on top of OneRoster for common operations.

Feature	Purpose
Enrollment Analytics	Aggregate XP, time, and progress per user
Subject Tracks	Manage K-12 curriculum sequences
Bulk Operations	Enroll/unenroll students efficiently
Weekly Facts	Quick insights for dashboards

Use EduBridge when you need simplified access to common queries.

QTI

Create, deliver, and score digital assessments using standardized question formats.

Feature	Purpose
Question Items	Multiple choice, true/false, fill-in
Assessment Tests	Combine items into quizzes and exams
Scoring	Automatic grading with rubrics
Item Banking	Reusable question libraries

Use QTI when you need standardized assessment formats that work across platforms.

PowerPath

Deliver adaptive quizzes that adjust difficulty based on student performance.

Feature	Purpose
Placement Tests	Determine starting grade level
Adaptive Quizzes	Questions adjust to student ability
Mastery Tracking	Monitor progress toward learning goals
Path Progression	Unlock content based on performance

Use PowerPath for personalized learning paths that adapt to each student.

CASE

Align educational content to academic standards frameworks.

Feature	Purpose
Standards Frameworks	Link to CCSS, NGSS, state standards
Competency Definitions	Define learning objectives
Content Alignment	Tag resources with standards
Crosswalks	Map between different frameworks

Use CASE when you need to demonstrate curriculum compliance.

CLR

Create comprehensive learner records that aggregate achievements across platforms.

Feature	Purpose
Achievement Records	Compile all learning accomplishments
Cross-Platform Data	Aggregate from multiple sources
Verifiable Transcripts	Cryptographically signed records
Standards-Based	Link achievements to competencies

Use CLR for portfolio systems or comprehensive learner records.

Open Badges

Issue and verify digital credentials.

Feature	Purpose
Badge Issuance	Create and award digital badges
Verification	Cryptographically verifiable credentials
Metadata	Rich descriptions of achievements
Portability	Students own and share their badges

Use Open Badges when you need verifiable digital credentials.

Authentication

All API requests require OAuth 2.0 authentication using the client credentials flow.

Get credentials

Complete first steps to receive your Client ID and Client Secret.

Generate access token

Exchange credentials for an access token:

curl -X POST $TIMEBACK_AUTH_URL/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRET"

Use token in requests

Include the token in all API requests. Tokens expire after 1 hour.

curl $TIMEBACK_API_URL/ims/oneroster/rostering/v1p2/courses \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Environments

Environment	Purpose
Staging	Development and testing
Production	Live applications

Credentials are environment-specific. Request access for each environment you need.

What’s Next

OneRoster API

Courses, enrollments, and assessment results

Caliper API

Activity tracking and learning events

Integration Levels

Choose your integration depth

Quickstart

Get started building

Overview

Caliper

CASE

CLR

EduBridge

OneRoster

PowerPath

QTI

Timeback Events

Webhooks

The APIs

Core APIs: OneRoster + Caliper

What OneRoster Manages

What Caliper Tracks

How They Work Together

Additional APIs

Authentication

Environments

What’s Next

OneRoster API

Caliper API

Integration Levels

Quickstart

​The APIs

​Core APIs: OneRoster + Caliper

​What OneRoster Manages

​What Caliper Tracks

​How They Work Together

​Additional APIs

​Authentication

​Environments

​What’s Next

OneRoster API

Caliper API

Integration Levels

Quickstart

The APIs

Core APIs: OneRoster + Caliper

What OneRoster Manages

What Caliper Tracks

How They Work Together

Additional APIs

Authentication

Environments

What’s Next