# List lessons

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

Operation ID: `lessons.list` · API v3

Returns the lessons of a product, using cursor pagination. Lesson bodies are not included; use the content endpoint to retrieve them.

The collection can be filtered by module, status, format, and name. Set `unassigned` to `true` to return only lessons that are not in a module. Trashed lessons are excluded by default; set `deleted` to `true` to return only lessons in the trash.

Required permissions: `lessons.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 |  |
| `module_id` | query | string | no |  |
| `unassigned` | query | boolean | no |  |
| `status` | query | string, one of `published`, `draft` | no |  |
| `format` | query | string, one of `standard`, `quiz`, `live_youtube`, `live_vimeo` | no |  |
| `q` | query | string | no |  |
| `deleted` | query | boolean | no |  |

## Responses

### 200

Returns the collection of lessons.

Body: `data`: array of Lesson.

Fields of Lesson:

| Field | Type | Required | Description |
|---|---|---|---|
| `connection` | object | yes |  |
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `exam_id` | string or null | yes | Public ID of the exam displayed in this lesson, or null when the lesson displays no exam. |
| `format` | string, one of `standard`, `quiz`, `live_youtube`, `live_vimeo` | yes |  |
| `id` | string | yes | Public ID, with the les_ prefix. |
| `image` | string or null | yes |  |
| `module_id` | string or null | yes | Public ID of the module that contains the lesson, or null in blog-format products. |
| `name` | string | yes |  |
| `object` | string, one of `lesson` | yes |  |
| `pinned` | boolean | yes |  |
| `position` | integer | yes |  |
| `product_id` | string | yes | Public ID, with the prd_ prefix. |
| `published_at` | string or null (date-time) | no |  |
| `revision` | string | yes |  |
| `settings` | object | yes | Lesson settings. Contains only supported keys; an empty object when no settings have been defined. |
| `status` | string, one of `published`, `draft` | yes |  |
| `summary` | string or null | 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