Quickstart

Step 1: Get your API key

Follow the Authentication guide to create an API key in your org settings. You’ll need it for every request.

Step 2: Verify your key works

The /v1/ping endpoint confirms your key is valid and shows which organisation it belongs to.

curl https://api.classquill.com/v1/ping \
  -H "Authorization: Token token=ei_live_your_key_here"

import requests

response = requests.get(
    "https://api.classquill.com/v1/ping",
    headers={"Authorization": "Token token=ei_live_your_key_here"},
)
print(response.json())

const response = await fetch("https://api.classquill.com/v1/ping", {
  headers: { Authorization: "Token token=ei_live_your_key_here" },
});
const data = await response.json();
console.log(data);

Expected response:

{
  "status": "ok",
  "org_id": "ce374c65-...",
  "org_name": "Your Organisation Name"
}

If you see a 401, double-check that:

Your key starts with ei_live_
The header format is exactly Token token=ei_live_... (note the space before token=)
The key has not been revoked in your org settings

Step 3: Fetch your sessions

Once your key is verified, you’re ready to pull real data.

curl "https://api.classquill.com/v1/sessions?limit=10" \
  -H "Authorization: Token token=ei_live_your_key_here"

Sessions are the core record — they power tutor earnings calculations, parent invoices, and accounting exports.

What’s next?

Sessions

List completed sessions, filter by tutor or student, and pull session details.

Invoices

Fetch invoices by organisation, parent, or date range for accounting reconciliation.

Getting Started

Endpoints

Step 1: Get your API key

Step 2: Verify your key works

Step 3: Fetch your sessions

What’s next?

Sessions

Invoices

​Step 1: Get your API key

​Step 2: Verify your key works

​Step 3: Fetch your sessions

​What’s next?

Sessions

Invoices

Step 1: Get your API key

Step 2: Verify your key works

Step 3: Fetch your sessions

What’s next?