Skip to main content

Overview

The timeback api command provides direct access to Timeback APIs from the command line.

Services

ServiceDescription
onerosterOneRoster 1.2 API
edubridgeEduBridge API
caliperCaliper Analytics API
powerpathPowerPath API
qtiQTI API

Discovery

View available resources and operations:
# View API documentation
timeback api docs oneroster

# List available resources
timeback api oneroster --help

Examples

OneRoster

# List schools
timeback api oneroster schools list

# List users (with limit)
timeback api oneroster users list --limit 100

# List enrollments (active only)
timeback api oneroster enrollments list --active

# Get specific user
timeback api oneroster users get <user-id>

# Create user from JSON file
timeback api oneroster users create --file user.json

# Filter with OneRoster filter syntax
timeback api oneroster users list --filter "role='student'"

# Delete a user
timeback api oneroster users delete <user-id>

EduBridge

# List enrollments for user
timeback api edubridge enrollments list <user-id>

# Get activity data
timeback api edubridge analytics activity --student-id <student-id>

# Get weekly facts
timeback api edubridge analytics weekly-facts --email [email protected]

# Get grade mastery
timeback api edubridge analytics grade-mastery <student-id> Math

Caliper

# List events
timeback api caliper events list --limit 50

# Get events for a specific actor
timeback api caliper events list --actor <user-id>

# Filter by event type
timeback api caliper events list --type AssessmentEvent

QTI

# List assessment items
timeback api qti items list

# Get specific item
timeback api qti items get <identifier>

PowerPath

# List test assignments
timeback api powerpath assignments list --student <student-id>

# Get placement level
timeback api powerpath placement level --student <student-id> --subject Math

# Get screening results
timeback api powerpath screening results --student <student-id>

Environment

Specify the target environment:
# Use production
timeback api oneroster schools list --env production

# Use staging (default)
timeback api oneroster schools list --env staging

Output Formats

# Default format: JSON
timeback api oneroster schools list

# Explicit JSON output
timeback api oneroster schools list --format json

# Table format (human-readable)
timeback api oneroster schools list --format table

# JSON Lines format
timeback api oneroster schools list --format jsonl

Credentials

API commands require credentials. Set them via:
  1. Environment variables (recommended for CI):
export ONEROSTER_CLIENT_ID=...
export ONEROSTER_CLIENT_SECRET=...
  1. Credentials command:
timeback credentials add
See CLI: Credentials for details.

Debug Mode

Enable verbose output to see request/response details:
DEBUG=1 timeback api oneroster schools list

Pagination

For large result sets:
# Limit results
timeback api oneroster users list --limit 50

# Offset pagination
timeback api oneroster users list --offset 100 --limit 50

Next Steps