---
title: "List Quiz Responses"
method: GET
path: "/quizzes/{quizId}/responses"
tags: ["quizzes"]
---

# List Quiz Responses

`GET /quizzes/{quizId}/responses`

## Request

- Base URL: `https://api.okendo.io/enterprise`
- URL: `https://api.okendo.io/enterprise/quizzes/{quizId}/responses`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/okendo/apis/okendo-enterprise-api/docs/quizzes/:quizId/responses/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of Quiz Responses for the requested quiz

## Path parameters

- `quizId` string, uuid, required

## Query parameters

- `limit` integer
- `lastEvaluated` string
- `orderBy` string

## Response `200`

An object containing a list of Quiz Responses and a relative link to the next page of results if available.

- object
  - `quizResponses` object[]
    - `subscriberId` string, uuid, required: Your user ID within Okendo.
    - `quizResponseId` string, uuid, required
    - `quizId` string, uuid, required
    - `quizName` string, required: The name of the quiz.
    - `channel` 'on-site' | 'on-site-embed', required: The channel through which the quiz was submitted.
    - `answeredQuestions` union[], required
      - union
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'multiple-select', required
          - `answer` string[], required: The selected answer options.
          - `customAnswer` string: Custom answer text provided by the respondent.
          - `customAnswerOptionText` string: Text for the custom answer option.
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'five-point' | 'star', required
          - `answer` number, required: The numeric answer provided.
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'profile', required
          - `answer` union, required: The profile answer data provided.
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `profileQuestionId` string, uuid, required
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'single-select', required
          - `answer` string, required: The selected answer option.
          - `customAnswer` string: Custom answer text provided by the respondent.
          - `customAnswerOptionText` string: Text for the custom answer option.
    - `customer` object
      - `customerId` string, uuid
      - `email` string, email
    - `dateCreated` string, date-time, required
    - `emailMarketingOptIn` boolean: Whether the customer opted in to email marketing.
    - `order` object
      - `remoteOrderId` string: The numeric order ID from Shopify.
    - `recommendation` union, required
      - object
        - `type` 'conditional-outcomes', required
        - `outcomeId` string, uuid, required: The unique identifier for the outcome.
        - `outcomeType` 'redirect', required
        - `outcomeInternalName` string: Internal name of the outcome.
        - `outcomeTitle` string, required: Title of the outcome.
        - `redirectUrl` string, uri, required: URL to redirect to.
      - object
        - `type` 'conditional-outcomes', required
        - `outcomeId` string, uuid, required: The unique identifier for the outcome.
        - `outcomeType` 'products', required
        - `outcomeInternalName` string: Internal name of the outcome.
        - `outcomeTitle` string, required: Title of the outcome.
        - `recommendedProducts` object[], required: List of recommended products.
          - `remoteProductId` string, required: The numeric product ID from Shopify.
          - `defaultRemoteVariantId` string: The default numeric variant ID from Shopify.
          - `remoteVariantIds` string[]: The numeric variant IDs from Shopify.
      - object
        - `type` 'weighted-products', required
        - `recommendedProducts` object[], required: List of recommended products with points.
          - `product` object, required
            - `remoteProductId` string, required: The numeric product ID from Shopify.
            - `defaultRemoteVariantId` string: The default numeric variant ID from Shopify.
            - `remoteVariantIds` string[]: The numeric variant IDs from Shopify.
          - `points` number, required: Points assigned to this product.
        - `runnerUpProducts` object[], required: List of runner-up products with points.
          - `product` object, required
            - `remoteProductId` string, required: The numeric product ID from Shopify.
            - `defaultRemoteVariantId` string: The default numeric variant ID from Shopify.
            - `remoteVariantIds` string[]: The numeric variant IDs from Shopify.
          - `points` number, required: Points assigned to this product.
      - object
        - `type` 'weighted-tags', required
        - `recommendedProducts` object[], required: List of recommended products with tags and points.
          - `product` object, required
            - `remoteProductId` string, required: The numeric product ID from Shopify.
            - `tags` string[], required: Tags associated with the product.
          - `points` number, required: Points assigned to this product.
        - `runnerUpProducts` object[], required: List of runner-up products with tags and points.
          - `product` object, required
            - `remoteProductId` string, required: The numeric product ID from Shopify.
            - `tags` string[], required: Tags associated with the product.
          - `points` number, required: Points assigned to this product.
    - `reward` object
      - `type` 'coupon', required: The type of reward.
      - `description` string, required: Description of the reward.
      - `value` string, required: The coupon code.
  - `nextUrl` string, uri

## Other responses

- `400`: Invalid request parameters.
- `401`: Authentication credentials are missing or incorrect.
- `404`: The requested resource could not be found.

---

[API](https://skmtc.dev/okendo/apis/okendo-enterprise-api.md) - [All operations](https://skmtc.dev/okendo/apis/okendo-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/okendo/apis/okendo-enterprise-api/revisions/dd4c80ed1613?raw)