Getting Started

The Quizzz API lets you manage your account's content over HTTPS — quizzes, students, assignments, results, and your public profile page. It is a REST API: resource-oriented URLs, JSON request and response bodies, and standard HTTP status codes.

Prefer plain language over code? Connect your account to Claude with the Claude Connector (MCP) and just ask. Or open Quizzz ↗ to manage things by hand.

Base URL

Environment	Base URL
Production	https://quizzz.techtranslab.com

All endpoints below are relative to this base, e.g. https://quizzz.techtranslab.com/api/v1/profile.

Get an API key

API access is available on the Pro plan. Create a key from your account settings under API Keys, choose the scopes it should have, and copy the key value — it is shown once at creation and starts with qz_.

No Pro plan? Use the Claude Connector (MCP)

The REST API below needs Pro, but the Claude Connector (MCP) is not plan-restricted — it works on the free plan too, and needs no API key.

Treat the key like a password: it carries the full access of the scopes you granted. Store it server-side and never embed it in client-side code.

Authenticate

Send the key as a Bearer token on every request:

curl https://quizzz.techtranslab.com/api/v1/info \
  -H "Authorization: Bearer qz_your_key_here"

A missing or invalid key returns 401. A key that lacks the scope a given endpoint requires returns 403.

Scopes

By default a key has full access to your account. When you create a key you can optionally restrict it to one or more scope groups — in the key dialog, expand Scopes and tick only the groups the key needs. An endpoint declares the scope it requires; the table on each reference page lists it.

Scope group	Permissions	Covers
info	api:info:read	Account info
profile	api:profile:read, api:profile:write	Public profile
branding	api:branding:read, api:branding:write	Site branding & SEO
quiz	api:quiz:read, api:quiz:write	Quizzes & generation
student	api:student:read, api:student:write	Student roster
assignment	api:assignment:read, api:assignment:write	Assignments / share links
collection	api:collection:read, api:collection:write	Quiz collections
result	api:result:read	Completion results

Rate limits

The API is available on the Pro plan only — keys on other plans are rejected with 401. Pro accounts are limited to 30 requests per minute, per account.

Exceeding the limit returns 429. Repeated failed-authentication attempts are throttled separately.

Your first call

Fetch your account info to confirm the key works:

curl https://quizzz.techtranslab.com/api/v1/info \
  -H "Authorization: Bearer qz_your_key_here"

{
  "data": {
    "teacher_id": "…",
    "email": "[email protected]",
    "plan_tier": "pro",
    "locale": "en"
  }
}

From here, head to the API Reference.