# List exams

`GET https://api.cademi.com.br/api/v3/products/{product_id}/exams`

Operation ID: `exams.list` · API v3

Returns the exams of the product. Requires the `exams.read` permission.

The collection never includes the correct alternatives; use the answer key operation, which requires the `exams.read_answer_key` permission.

Required permissions: `exams.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `product_id` | path | string | yes |  |
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `sort` | query | string, one of `id`, `-id` | no |  |
| `lesson_id` | query | string | no | Public ID of a lesson. Returns only the exam displayed by that lesson. |
| `deleted` | query | boolean | no |  |

## Responses

### 200

Returns the collection of exams.

Body: `data`: array of Exam.

Fields of Exam:

| Field | Type | Required | Description |
|---|---|---|---|
| `attempts_count` | integer | yes | Number of attempts recorded for the exam. |
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `description` | string | yes |  |
| `id` | string | yes | Public ID of the exam, prefixed with exm_. |
| `lesson_ids` | array of string | yes | Public IDs of the lessons that display this exam, prefixed with les_. |
| `object` | string, one of `exam` | yes |  |
| `product_id` | string | yes | Public ID of the product, prefixed with prd_. |
| `questions_count` | integer | yes | Number of active (non-deleted) questions in the exam. |
| `revision` | string | yes |  |
| `settings` | object | yes | Exam settings, with a fixed set of keys. Numeric settings are null when no limit applies. |
| `title` | string | yes |  |
| `updated_at` | string (date-time) | yes |  |

### 400

The cursor is invalid or the request contains an unsupported query parameter.

Body: Error.

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

### 404

The product was not found or is not accessible with the current credentials.

Body: Error.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

Full schema: https://cademi.dev/openapi/v3.json