API Overview
The Quizzz API exposes REST endpoints under /api/v1. All requests and responses use JSON unless noted (the results export returns CSV).
Authentication
Every endpoint requires a Bearer API key:
Authorization: Bearer qz_your_key_hereSee Getting Started for how to create a key, the available scopes, and rate limits.
Base URL
https://quizzz.techtranslab.comResponse envelope
Successful responses wrap the payload in a data field:
{ "data": { "…": "…" } }Errors
Errors return a non-2xx status with an error message. Some endpoints add an errorCode (or code) and field-level details:
{ "error": "Insufficient scope. This API key does not have the required permission." }| Status | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request (validation error) |
| 401 | Unauthorized (missing / invalid key) |
| 403 | Forbidden (insufficient scope, or quota exceeded) |
| 404 | Not found |
| 409 | Conflict (e.g. profile slug already taken) |
| 429 | Rate limited |
| 500 | Server error |
Content units
Three resources hold teaching content, at three sizes:
| Unit | Resource | What it is |
|---|---|---|
| Question | Question bank | One reusable question, kept outside any quiz |
| Quiz | Quizzes | The paper a student takes; it holds its own copy of each question |
| Collection | Collections | Two or more existing quizzes behind one link |
Creating a question creates no quiz, and a quiz is created with its questions inline — no bank question has to exist first. Saving a quiz — here, in the teacher console, or through the Claude connector — also adds its storable questions to the bank automatically, so do not post them to the bank as well. See Question Bank, Quizzes, and Collections for how the three relate.
Resources
| Resource | Description |
|---|---|
| Account | Read account info and usage |
| Profile | Edit and publish your public /t/<slug> profile |
| Branding | Site name, theme, and SEO metadata |
| Quizzes | List, create, update, delete, and generate quizzes |
| Question bank | Store, search, update, and archive reusable questions |
| Students | Manage your student roster |
| Assignments | Create share links / individual assignments |
| Collections | Bundle quizzes behind one shareable link with easy / medium / hard levels |
| Results | Read completion results and CSV export |