Appearance
Get All Quiz IDs
Retrieve IDs of all quizzes within a specific namespace.
Overview
This endpoint returns an array of all quiz identifiers available in the specified namespace.
Method: GET
Endpoint:/api/v1/namespaces/:namespaceId/allQuizIds
Requires administrative authentication.
Request
Headers
http
x-api-key: {your_api_key} # Required
Accept: application/jsonPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
namespaceId | string | ✅ | Namespace unique ID |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ignoreEndedQuizzes | boolean | ❌ | Flag to exclude quizzes past their end date |
Response
json
{
"quizzes": [
{
"id": "sample-quiz",
"name": "sample-quiz",
"primaryColor": "#9b8163",
"createdOn": 1626101719367,
"start": 1626246000000,
"end": 1626417959999,
"questions": [... ],
"anonymous": false,
"status": "queued",
"disableEmailing": false,
"userErrorCount": 0,
"userCount": 4,
"csvErrors": [],
"csvStatus": "done",
"emailedOn": null,
"wasReminded": false
},
{... }
],
"nextPageId": null,
"prevPageId": null
}Error Responses
500 Internal Server Error– If the namespace does not exist
json
{
"error": "namespace does not exist"
}Authorization Requirements
This endpoint requires authentication with one of the following permissions:
- System administrator
- Namespace administrator
Notes
- While this is a GET request, it accepts a body parameter (
ignoreEndedQuizzes). This is non-standard for REST APIs, so consider using a query parameter instead when implementing clients.