Skip to main content
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. Timeback API architecture

​
The APIs

APIPurpose
OneRosterManage courses, rosters, enrollments, and assessment results
EduBridgeSimplified resource management and pre-aggregated analytics
CaliperTrack learning sessions, activity events, and calculate XP
QTICreate, deliver, and score digital assessments
PowerPathAdaptive quizzes, placement tests, and mastery progression
CASEAlign content to academic standards (CCSS, NGSS, state frameworks)
Open BadgesIssue and verify digital credentials
CLRComprehensive 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.

​
What OneRoster Manages

ResourcePurpose
CoursesWhat content exists (“Math Grade 5”)
ClassesSpecific offerings of a course
StudentsWho uses your app
EnrollmentsWho can access what
ResourcesLearning materials (videos, quizzes)
AssessmentResultsScores and XP earned
Use OneRoster when you need to structure educational content, manage student enrollments, or store assessment results.

​
How They Work Together

1

Create course structure

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

Enroll students

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

Track learning

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

Store results

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

​
Additional APIs

Convenience layer on top of OneRoster for common operations.
FeaturePurpose
Enrollment AnalyticsAggregate XP, time, and progress per user
Subject TracksManage K-12 curriculum sequences
Bulk OperationsEnroll/unenroll students efficiently
Weekly FactsQuick insights for dashboards
Use EduBridge when you need simplified access to common queries.
Create, deliver, and score digital assessments using standardized question formats.
FeaturePurpose
Question ItemsMultiple choice, true/false, fill-in
Assessment TestsCombine items into quizzes and exams
ScoringAutomatic grading with rubrics
Item BankingReusable question libraries
Use QTI when you need standardized assessment formats that work across platforms.
Deliver adaptive quizzes that adjust difficulty based on student performance.
FeaturePurpose
Placement TestsDetermine starting grade level
Adaptive QuizzesQuestions adjust to student ability
Mastery TrackingMonitor progress toward learning goals
Path ProgressionUnlock content based on performance
Use PowerPath for personalized learning paths that adapt to each student.
Align educational content to academic standards frameworks.
FeaturePurpose
Standards FrameworksLink to CCSS, NGSS, state standards
Competency DefinitionsDefine learning objectives
Content AlignmentTag resources with standards
CrosswalksMap between different frameworks
Use CASE when you need to demonstrate curriculum compliance.
Create comprehensive learner records that aggregate achievements across platforms.
FeaturePurpose
Achievement RecordsCompile all learning accomplishments
Cross-Platform DataAggregate from multiple sources
Verifiable TranscriptsCryptographically signed records
Standards-BasedLink achievements to competencies
Use CLR for portfolio systems or comprehensive learner records.
Issue and verify digital credentials.
FeaturePurpose
Badge IssuanceCreate and award digital badges
VerificationCryptographically verifiable credentials
MetadataRich descriptions of achievements
PortabilityStudents 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.
1

Get credentials

Apply to the Developer Program to receive your Client ID and Client Secret.
2

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"
3

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

EnvironmentPurpose
StagingDevelopment and testing
ProductionLive 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