For Developers

APIReference

Integrate TheRevisionHub into your applications with our RESTful API. Built for developers, designed for education.

Getting Started

Authentication

API Keys

All API requests require authentication using an API key. Include your API key in theAuthorization header with the Bearer token format.

API keys are available on School and Enterprise plans. Contact sales to get access.

Header Example
Authorization: Bearer trh_live_xxxxxxxxxxxxxxxxxxxxxxxx

Base URL

All API requests should be made to the following base URL:

https://api.therevisionhub.com/v1
Endpoints

API Endpoints

Available endpoints for integrating with TheRevisionHub

GET/api/v1/users

List all users in your organization

GET/api/v1/users/:id

Get a specific user's details

GET/api/v1/courses

List all courses

POST/api/v1/courses

Create a new course

GET/api/v1/courses/:id

Get course details

GET/api/v1/lessons

List all lessons

GET/api/v1/progress

Get learning progress data

GET/api/v1/analytics

Get analytics and insights

Examples

Code Examples

Get started quickly with these code snippets

cURL
curl -X GET "https://api.therevisionhub.com/v1/courses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
JavaScript
const response = await fetch('https://api.therevisionhub.com/v1/courses', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.therevisionhub.com/v1/courses',
    headers=headers
)

data = response.json()
print(data)
Responses

Response Format

JSON Responses

All API responses are returned in JSON format with consistent structure.

JSON Response Example
{
  "success": true,
  "data": {
    "id": "course_123",
    "name": "GCSE Mathematics",
    "subject": "Mathematics",
    "level": "GCSE",
    "examBoard": "AQA",
    "lessons": 24,
    "students": 156
  },
  "meta": {
    "timestamp": "2026-03-28T10:30:00Z",
    "requestId": "req_abc123"
  }
}
Resources

Additional Resources

Need API Access?

API access is available for School and Enterprise plans. Contact our sales team to get started.