---
title: "Reads one quiz with its questions."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › quiz

`GET /v1/stores/{store}/products/{product}/entries/{entry}/quizzes/{quiz}`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `quiz:read`

## Path parameters

- `store` (`getQuiz.path.store`; string, required) — The store's id.
- `product` (`getQuiz.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1
- `entry` (`getQuiz.path.entry`; string, required)
  - minLength 1
- `quiz` (`getQuiz.path.quiz`; string, required)
  - minLength 1

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/entries/<entry>/quizzes/<quiz>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/entries/<entry>/quizzes/<quiz>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/entries/<entry>/quizzes/<quiz>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads one quiz with its questions.

#### Example

```json
{
  "body": {
    "attachment_id": "string",
    "asset_id": "string",
    "title": "string",
    "blocks": [
      {
        "type": "string",
        "id": "string",
        "property1": true,
        "property2": true
      }
    ]
  },
  "question_count": 0,
  "files": {
    "property1": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    },
    "property2": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    }
  },
  "sittings": 0,
  "certificates": [
    {
      "logo": {
        "attachment_id": "string",
        "asset_id": "string"
      },
      "id": "string",
      "product_id": "string",
      "quiz_id": "string",
      "headline_copy": "string",
      "title_copy": "string",
      "awarded_copy": "string",
      "reason_copy": "string",
      "score_copy": "string",
      "out_of_score_copy": "string",
      "settings": {
        "template": "string",
        "accent": "string",
        "requires_passing": true,
        "earned_on": "string",
        "shows": [
          "string"
        ]
      },
      "created_at": "string"
    }
  ],
  "id": "string",
  "entry_id": "string",
  "product_id": "string",
  "version": 0,
  "settings": {
    "attempts_allowed": 0,
    "pass_mark": 0,
    "show_answers": true
  },
  "created_at": "string",
  "updated_at": "string"
}
```

- `body` (`getQuiz.response.200.body`; object, required)
  - `attachment_id` (`getQuiz.response.200.body.attachment_id`; string, required)
  - `asset_id` (`getQuiz.response.200.body.asset_id`; string, required)
  - `title` (`getQuiz.response.200.body.title`; any of, required)
    - any of: `string`, `null`
  - `blocks` (`getQuiz.response.200.body.blocks`; array<object>, required)
    - `type` (`getQuiz.response.200.body.blocks.type`; string, required)
    - `id` (`getQuiz.response.200.body.blocks.id`; string, required)
- `question_count` (`getQuiz.response.200.question_count`; number, required) — How many of its blocks are questions a sitter answers.
- `files` (`getQuiz.response.200.files`; map<object>, required)
- `sittings` (`getQuiz.response.200.sittings`; number, required)
- `certificates` (`getQuiz.response.200.certificates`; array<object>, required)
  - `logo` (`getQuiz.response.200.certificates.logo`; any of, required)
    - any of: `object`, `null`
  - `id` (`getQuiz.response.200.certificates.id`; string, required)
  - `product_id` (`getQuiz.response.200.certificates.product_id`; string, required)
  - `quiz_id` (`getQuiz.response.200.certificates.quiz_id`; any of, required)
    - any of: `string`, `null`
  - `headline_copy` (`getQuiz.response.200.certificates.headline_copy`; string, required)
  - `title_copy` (`getQuiz.response.200.certificates.title_copy`; any of, required)
    - any of: `string`, `null`
  - `awarded_copy` (`getQuiz.response.200.certificates.awarded_copy`; any of, required)
    - any of: `string`, `null`
  - `reason_copy` (`getQuiz.response.200.certificates.reason_copy`; any of, required)
    - any of: `string`, `null`
  - `score_copy` (`getQuiz.response.200.certificates.score_copy`; any of, required)
    - any of: `string`, `null`
  - `out_of_score_copy` (`getQuiz.response.200.certificates.out_of_score_copy`; any of, required)
    - any of: `string`, `null`
  - `settings` (`getQuiz.response.200.certificates.settings`; object, required)
    - `template` (`getQuiz.response.200.certificates.settings.template`; string, required)
    - `accent` (`getQuiz.response.200.certificates.settings.accent`; any of, required)
      - any of: `string`, `null`
    - `requires_passing` (`getQuiz.response.200.certificates.settings.requires_passing`; boolean, optional) — Earned by passing the quiz, not by merely finishing it.
    - `earned_on` (`getQuiz.response.200.certificates.settings.earned_on`; string, optional) — Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.
    - `shows` (`getQuiz.response.200.certificates.settings.shows`; array<string>, optional)
  - `created_at` (`getQuiz.response.200.certificates.created_at`; any of, required)
    - any of: `string`, `null`
- `id` (`getQuiz.response.200.id`; string, required)
- `entry_id` (`getQuiz.response.200.entry_id`; string, required)
- `product_id` (`getQuiz.response.200.product_id`; string, required)
- `version` (`getQuiz.response.200.version`; number, required)
- `settings` (`getQuiz.response.200.settings`; object, required)
  - `attempts_allowed` (`getQuiz.response.200.settings.attempts_allowed`; any of, required)
    - any of: `number`, `null`
  - `pass_mark` (`getQuiz.response.200.settings.pass_mark`; any of, required)
    - any of: `number`, `null`
  - `show_answers` (`getQuiz.response.200.settings.show_answers`; boolean, required)
- `created_at` (`getQuiz.response.200.created_at`; any of, required)
  - any of: `string`, `null`
- `updated_at` (`getQuiz.response.200.updated_at`; any of, required)
  - any of: `string`, `null`

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`getQuiz.response.default.type`; string, required)
  - format `uri`
- `title` (`getQuiz.response.default.title`; string, required)
- `status` (`getQuiz.response.default.status`; integer, required)
- `detail` (`getQuiz.response.default.detail`; string, required)
- `code` (`getQuiz.response.default.code`; string, optional)
- `context` (`getQuiz.response.default.context`; object, optional)
- `reached_core` (`getQuiz.response.default.reached_core`; boolean, optional)
- `core_answer` (`getQuiz.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/get-quiz/index.md
