# List modules

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

Operation ID: `modules.list` · API v3

Returns the modules and groups of a product, ordered by position and paginated with a cursor.

The collection can be filtered by parent group, status, kind, and deletion state.

If the product is not accessible with the current credentials, the API returns `404 Not Found` instead of an empty collection.

Required permissions: `modules.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 `position`, `-position` | no |  |
| `parent_id` | query | string | no |  |
| `status` | query | string, one of `published`, `draft` | no |  |
| `kind` | query | string, one of `group`, `module` | no |  |
| `deleted` | query | boolean | no |  |

## Responses

### 200

Returns the collection of modules.

Body: `data`: array of Module.

Fields of Module:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `id` | string | yes | Public ID, with the mod_ prefix. |
| `image` | string or null | yes |  |
| `kind` | string, one of `group`, `module` | yes |  |
| `lessons_count` | integer | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `module` | yes |  |
| `parent_id` | string or null | yes |  |
| `position` | integer | yes |  |
| `product_id` | string | yes | Public ID, with the prd_ prefix. |
| `revision` | string | yes |  |
| `settings` | object | yes | Module settings. Only type is supported; an empty object when no settings have been defined. |
| `status` | string, one of `published`, `draft` | 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