Developer API Documentation
Integrate OpenQuiz into your applications with our comprehensive REST API.
Getting Started
https://your-openquiz-host.exampleAuthentication
Protected account and host endpoints require the access token issued after sign-in. Public lobby lookup and registration have separate access rules. Include the access token in the Authorization header:
Authorization: Bearer YOUR_ACCESS_TOKENAPI Endpoints
Authentication
Learn how to authenticate API requests
/api/auth/loginUser login
/api/auth/send-registration-otpRequest a registration code when email delivery is configured
/api/auth/register-with-otpRegister with a valid verification code
/api/auth/profileGet user profile
Quizzes
Manage quizzes programmatically
/api/quizzesList your quizzes
/api/quizzesCreate a new quiz
/api/quizzes/:idGet quiz details
/api/quizzes/:idUpdate quiz
/api/quizzes/:idDelete quiz
Games
Control and manage live games
/api/gamesStart a new game
/api/games/:pinGet game details
/api/games/:pin/startStart the game
/api/games/:pin/end-questionClose the current question; expected_question_index is required
/api/games/:pin/nextAdvance once; expected_question_index is required
Need API Access?
API access is available for Pro and Enterprise plans. Contact us to get started.