Appearance
Get Quiz Public Info
Retrieve public information about a specific quiz.
Overview
This endpoint returns the publicly available information for a quiz. This is a more limited view compared to the full quiz details and is accessible without authentication.
Method: GET
Endpoint:/api/v1/namespaces/:namespaceId/quizzes/:quizId/public
Authentication is optional for this endpoint.
Request
Headers
http
Accept: application/jsonPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
namespaceId | string | ✅ | Namespace unique ID |
quizId | string | ✅ | Quiz unique ID |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
language | string | ❌ | Preferred language for content |
Response
json
{
"quiz": {
"id": "sample-quiz",
"name": "sample-quiz",
"primaryColor": "#9b8163",
"createdOn": 1626101719367,
"start": 1626246000000,
"end": 1626417959999,
"questions": [... ],
"anonymous": false,
"status": "queued"
}
}Error Responses
500 Internal Server Error– If the namespace does not exist
json
{
"error": "namespace does not exist"
}500 Internal Server Error– If the quiz does not exist
json
{
"error": "quiz does not exist"
}Notes
- This endpoint provides a public view of quiz information and is accessible without authentication
- The response contains a subset of the quiz details compared to the authenticated endpoint
- Can be used for quiz preview purposes or public-facing applications