Get a Single Quiz

Retrieve detailed information about a specific quiz.

---

Overview

This endpoint returns comprehensive details for a single quiz identified by its unique ID within a namespace.

Method: GET
Endpoint:
/api/v1/namespaces/:namespaceId/quizzes/:quizId

Requires administrative authentication or demo access. Some publicly available quizzes (for admins) are classified as demo for your reference, and passing this flag may be needed to retrieve them.

---

Request

Headers

x-api-key: {your_api_key}  # Required
Accept: application/json

Path Parameters

Parameter	Type	Required	Description
namespaceId	string	✅	Namespace unique ID
quizId	string	✅	Quiz unique ID

Query Parameters

Parameter	Type	Required	Description
isDemo	boolean	❌	Flag to indicate demo mode access

---

Response

{
  "quiz": {
    "id": "sample-quiz-id",
    "namespace": "api-testing-env",
    "name": "Sample Quiz Name",
    "primaryColor": "#3366ff",
    "customCTA": {
      "ctaLink": "https://example.com",
      "ctaTitle": "Learn More",
      "ctaButton": "Click Here",
      "ctaDescription": "Find out more about our services",
      "sticky": true
    },
    "customRecommendationCard": {
      "card1": {
        "title": "Recommendation Title",
        "subtitle": "Recommendation Subtitle",
        "recommendationTitle": "Try These Steps",
        "recommendations": ["Step 1", "Step 2", "Step 3"],
        "CTA1Button": "Learn More",
        "CTA1Link": "https://example.com/learn",
        "CTA2Button": "Learn More 2",
        "CTA2Link": "https://example.com/learn2"
      }
    },
    "customIntroScreen": {
      "headerMessage": "Welcome to our Survey",
      "mainMessage": "Help us understand your needs better",
      "buttonMessage": "Start Survey",
      "footnoteMessage": "Your responses are confidential",
      "customLogoUrl": "https://storage.googleapis.com/example/logo.png",
      "inheritLogo": true
    },
    "hasCustomIntro": true,
    "customOutroScreen": {
      "outroMessage": "Thank you for completing the survey"
    },
    "hasCustomOutro": true,
    "demographicMessage": "The following information is confidential and is protected under...",
    "endScreenMessage": "Thank you for participating",
    "disableResultScreen": false,
    "createdOn": 1626101719367,
    "start": 1626246000000,
    "end": 1626417959999,
    "retry": 1626417959999,
    "retryAfterDays": 30,
    "questions": [...],
    "anonymous": false,
    "inapp": false,
    "fhscore": true,
    "status": "Active",
    
    "disableEmailing": false,
    "userErrorCount": 0,
    "userCount": 10,
    "completedUserCount": 8,
    "lastResponseDate": "2025-07-15T22:40:03.000Z",
    "openUserCount": 10,
    "answeringUserCount": 8,
    "anonUserCount": 0,
    "completedAnonUserCount": 0,
    "csvErrors": [],
    "csvStatus": "done",
    "emailedOn": 1626101719367,
    "wasReminded": false,
    "remindedOn": null,
    "csvExportPath": "path/to/export.csv",
    "csvExportStatus": "complete",
    "csvExportExpiration": 1626417959999,
    "csvUnfinishedUsersPath": "path/to/unfinished.csv",
    "csvUnfinishedUsersStatus": "complete",
    "csvUnfinishedUsersExpiration": 1626417959999,
    "csvLongitudinalComparisonPath": "path/to/comparison.csv",
    "csvLongitudinalComparisonExpiration": 1626417959999,
    "lastDfUpdate": "2025-07-15T22:40:03.000Z"
  }
}

When accessed in demo mode, the response includes additional isDemo and namespaceId properties.

---