Skip to content

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_here

See Getting Started for how to create a key, the available scopes, and rate limits.

Base URL ​

https://quizzz.techtranslab.com

Response envelope ​

Successful responses wrap the payload in a data field:

json
{ "data": { "…": "…" } }

Errors ​

Errors return a non-2xx status with an error message. Some endpoints add an errorCode (or code) and field-level details:

json
{ "error": "Insufficient scope. This API key does not have the required permission." }
StatusMeaning
200Success
201Created
400Bad request (validation error)
401Unauthorized (missing / invalid key)
403Forbidden (insufficient scope, or quota exceeded)
404Not found
409Conflict (e.g. profile slug already taken)
429Rate limited
500Server error

Content units ​

Three resources hold teaching content, at three sizes:

UnitResourceWhat it is
QuestionQuestion bankOne reusable question, kept outside any quiz
QuizQuizzesThe paper a student takes; it holds its own copy of each question
CollectionCollectionsTwo 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 ​

ResourceDescription
AccountRead account info and usage
ProfileEdit and publish your public /t/<slug> profile
BrandingSite name, theme, and SEO metadata
QuizzesList, create, update, delete, and generate quizzes
Question bankStore, search, update, and archive reusable questions
StudentsManage your student roster
AssignmentsCreate share links / individual assignments
CollectionsBundle quizzes behind one shareable link with easy / medium / hard levels
ResultsRead completion results and CSV export

TechTrans Lab