Guide

Quiz Cast REST API

Session lifecycle routes under prc-api/v3. Source: includes/class-rest-api.php.

Base path: /wp-json/prc-api/v3/

Auth

Both routes require header X-PRC-User-Token (Firebase ID token). Missing token → 401 missing_token.

POST /quiz/session-create

Creates a Firebase session and unique join code.

Reference

Request body

Typed options, defaults, and constraints in one scannable reference.
7 fields
quizId number required
Quiz post ID.
paceMode enum required
Who advances questions.
avatarPack string
Avatar pack slug.
sessionName string
Display name for the session.
saveResults boolean
Persist results on finalize.
timerSeconds number
Per-question timer (0–300).
timerAction enum
When the timer ends.

Join-code generation failure after retries → 503 join_code_exhausted.

POST /quiz/session-finalize

Persists optional results and cleans up the Firebase session.

Reference

Request body

Typed options, defaults, and constraints in one scannable reference.
2 fields
sessionId string required
20-character session id ([a-zA-Z0-9_-]).
groupName string
Optional group label when saving results.

Was this helpful?