---
title: "Reads one quiz attempt with its answers."
---

> 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}/attempts/{attempt}`

## Authentication

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attempts/<attempt>';
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>/attempts/<attempt>"

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

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

print(response.text)
```

## Responses

### 200

Reads one quiz attempt with its answers.

#### Example

```json
{
  "customer": {
    "id": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "erased": true
  },
  "quiz": {
    "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"
  },
  "id": "string",
  "product_id": "string",
  "quiz_id": "string",
  "customer_id": "string",
  "attempt": 0,
  "status": "string",
  "answers": {
    "property1": {
      "answer": true,
      "correct": true,
      "weight": 0,
      "dropped": true,
      "property1": true,
      "property2": true
    },
    "property2": {
      "answer": true,
      "correct": true,
      "weight": 0,
      "dropped": true,
      "property1": true,
      "property2": true
    }
  },
  "score": 0,
  "correct": 0,
  "started_at": "string",
  "finished_at": "string"
}
```

- `customer` (`getAttempt.response.200.customer`; any of, required)
  - any of: `object`, `null`
- `quiz` (`getAttempt.response.200.quiz`; object, required)
  - `body` (`getAttempt.response.200.quiz.body`; object, required)
    - `attachment_id` (`getAttempt.response.200.quiz.body.attachment_id`; string, required)
    - `asset_id` (`getAttempt.response.200.quiz.body.asset_id`; string, required)
    - `title` (`getAttempt.response.200.quiz.body.title`; any of, required)
      - any of: `string`, `null`
    - `blocks` (`getAttempt.response.200.quiz.body.blocks`; array<object>, required)
      - `type` (`getAttempt.response.200.quiz.body.blocks.type`; string, required)
      - `id` (`getAttempt.response.200.quiz.body.blocks.id`; string, required)
  - `question_count` (`getAttempt.response.200.quiz.question_count`; number, required) — How many of its blocks are questions a sitter answers.
  - `files` (`getAttempt.response.200.quiz.files`; map<object>, required)
  - `sittings` (`getAttempt.response.200.quiz.sittings`; number, required)
  - `certificates` (`getAttempt.response.200.quiz.certificates`; array<object>, required)
    - `logo` (`getAttempt.response.200.quiz.certificates.logo`; any of, required)
      - any of: `object`, `null`
    - `id` (`getAttempt.response.200.quiz.certificates.id`; string, required)
    - `product_id` (`getAttempt.response.200.quiz.certificates.product_id`; string, required)
    - `quiz_id` (`getAttempt.response.200.quiz.certificates.quiz_id`; any of, required)
      - any of: `string`, `null`
    - `headline_copy` (`getAttempt.response.200.quiz.certificates.headline_copy`; string, required)
    - `title_copy` (`getAttempt.response.200.quiz.certificates.title_copy`; any of, required)
      - any of: `string`, `null`
    - `awarded_copy` (`getAttempt.response.200.quiz.certificates.awarded_copy`; any of, required)
      - any of: `string`, `null`
    - `reason_copy` (`getAttempt.response.200.quiz.certificates.reason_copy`; any of, required)
      - any of: `string`, `null`
    - `score_copy` (`getAttempt.response.200.quiz.certificates.score_copy`; any of, required)
      - any of: `string`, `null`
    - `out_of_score_copy` (`getAttempt.response.200.quiz.certificates.out_of_score_copy`; any of, required)
      - any of: `string`, `null`
    - `settings` (`getAttempt.response.200.quiz.certificates.settings`; object, required)
      - `template` (`getAttempt.response.200.quiz.certificates.settings.template`; string, required)
      - `accent` (`getAttempt.response.200.quiz.certificates.settings.accent`; any of, required)
        - any of: `string`, `null`
      - `requires_passing` (`getAttempt.response.200.quiz.certificates.settings.requires_passing`; boolean, optional) — Earned by passing the quiz, not by merely finishing it.
      - `earned_on` (`getAttempt.response.200.quiz.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` (`getAttempt.response.200.quiz.certificates.settings.shows`; array<string>, optional)
    - `created_at` (`getAttempt.response.200.quiz.certificates.created_at`; any of, required)
      - any of: `string`, `null`
  - `id` (`getAttempt.response.200.quiz.id`; string, required)
  - `entry_id` (`getAttempt.response.200.quiz.entry_id`; string, required)
  - `product_id` (`getAttempt.response.200.quiz.product_id`; string, required)
  - `version` (`getAttempt.response.200.quiz.version`; number, required)
  - `settings` (`getAttempt.response.200.quiz.settings`; object, required)
    - `attempts_allowed` (`getAttempt.response.200.quiz.settings.attempts_allowed`; any of, required)
      - any of: `number`, `null`
    - `pass_mark` (`getAttempt.response.200.quiz.settings.pass_mark`; any of, required)
      - any of: `number`, `null`
    - `show_answers` (`getAttempt.response.200.quiz.settings.show_answers`; boolean, required)
  - `created_at` (`getAttempt.response.200.quiz.created_at`; any of, required)
    - any of: `string`, `null`
  - `updated_at` (`getAttempt.response.200.quiz.updated_at`; any of, required)
    - any of: `string`, `null`
- `id` (`getAttempt.response.200.id`; string, required)
- `product_id` (`getAttempt.response.200.product_id`; string, required)
- `quiz_id` (`getAttempt.response.200.quiz_id`; string, required)
- `customer_id` (`getAttempt.response.200.customer_id`; string, required)
- `attempt` (`getAttempt.response.200.attempt`; number, required)
- `status` (`getAttempt.response.200.status`; string, required)
- `answers` (`getAttempt.response.200.answers`; map<object>, required)
- `score` (`getAttempt.response.200.score`; any of, required)
  - any of: `number`, `null`
- `correct` (`getAttempt.response.200.correct`; any of, required)
  - any of: `number`, `null`
- `started_at` (`getAttempt.response.200.started_at`; any of, required)
  - any of: `string`, `null`
- `finished_at` (`getAttempt.response.200.finished_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` (`getAttempt.response.default.type`; string, required)
  - format `uri`
- `title` (`getAttempt.response.default.title`; string, required)
- `status` (`getAttempt.response.default.status`; integer, required)
- `detail` (`getAttempt.response.default.detail`; string, required)
- `code` (`getAttempt.response.default.code`; string, optional)
- `context` (`getAttempt.response.default.context`; object, optional)
- `reached_core` (`getAttempt.response.default.reached_core`; boolean, optional)
- `core_answer` (`getAttempt.response.default.core_answer`; string, optional)


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