Quizzes

Merchant REST API endpoints related to Okendo Quizzes

List Quiz Responses

get

Returns a list of Quiz Responses for the requested quiz

Authorizations

basic

AuthorizationstringRequired

Path parameters

quizIdstring · uuidRequired

The ID of the quiz to retrieve responses for

Query parameters

limitinteger · int32Optional

A limit on the number of items returned. Between 1 and 100. Default 25.

Example: 25

lastEvaluatedstringOptional

The URL-encoded JSON object representing the cursor for the next page of results.

orderBystringOptional

The sort order of the quiz responses. Format: '(date) (asc|desc)'. Default 'date desc'

Example: date desc

Responses

200

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

application/json

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

404

The requested resource could not be found.

application/json

get

/quizzes/{quizId}/responses

HTTPcURLJavaScriptPython

GET /enterprise/quizzes/{quizId}/responses HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "quizResponses": [
    {
      "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
      "quizResponseId": "123e4567-e89b-12d3-a456-426614174000",
      "quizId": "123e4567-e89b-12d3-a456-426614174000",
      "quizName": "text",
      "channel": "on-site",
      "answeredQuestions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text",
          "type": "multiple-select",
          "answer": [
            "text"
          ],
          "customAnswer": "text",
          "customAnswerOptionText": "text"
        }
      ],
      "customer": {
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]"
      },
      "dateCreated": "2026-02-02T14:42:17.678Z",
      "emailMarketingOptIn": true,
      "order": {
        "remoteOrderId": "text"
      },
      "recommendation": {
        "type": "conditional-outcomes",
        "outcomeId": "123e4567-e89b-12d3-a456-426614174000",
        "outcomeType": "redirect",
        "outcomeInternalName": "text",
        "outcomeTitle": "text",
        "redirectUrl": "https://example.com"
      },
      "reward": {
        "type": "coupon",
        "description": "text",
        "value": "text"
      }
    }
  ],
  "nextUrl": "https://example.com"
}