API Reference

Developer API Documentation

Integrate OpenQuiz into your applications with our comprehensive REST API.

Getting Started

Base URL
https://api.openquiz.io

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API Endpoints

Authentication

Learn how to authenticate API requests

POST
/api/auth/login

User login

POST
/api/auth/register

User registration

GET
/api/auth/profile

Get user profile

Quizzes

Manage quizzes programmatically

GET
/api/quizzes

List all quizzes

POST
/api/quizzes

Create a new quiz

GET
/api/quizzes/:id

Get quiz details

PUT
/api/quizzes/:id

Update quiz

DELETE
/api/quizzes/:id

Delete quiz

Games

Control and manage live games

POST
/api/games

Start a new game

GET
/api/games/:pin

Get game details

POST
/api/games/:pin/start

Start the game

POST
/api/games/:pin/next

Move to next question

Webhooks

Subscribe to real-time events

POST
/api/webhooks

Create webhook

GET
/api/webhooks

List webhooks

DELETE
/api/webhooks/:id

Delete webhook

Need API Access?

API access is available for Pro and Enterprise plans. Contact us to get started.