# List products

`GET https://api.cademi.com.br/api/v3/products`

Operation ID: `products.list` · API v3

Lists the products of the account. Results are paginated with a cursor and can be filtered by showcase, status, external ID, search term, and deletion state.

If the credentials are limited to specific products, only those products are returned.

Required permissions: `products.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `sort` | query | string, one of `id`, `-id` | no |  |
| `showcase_id` | query | string | no |  |
| `status` | query | string, one of `published`, `draft`, `unlisted`, `hidden` | no |  |
| `external_id` | query | string | no |  |
| `q` | query | string | no |  |
| `deleted` | query | boolean | no |  |

## Responses

### 200

Returns the collection of products.

Body: `data`: array of Product.

Fields of Product:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `definitions` | object | yes | Product definitions. Only aliasproductid is supported; an empty object unless the product uses the alias format. |
| `deleted` | boolean | yes |  |
| `display` | object | yes | Display options. Only hidemodulebar and show_progress are supported; an empty object when no options have been defined. |
| `external_id` | string or null | no |  |
| `format` | string, one of `course`, `flix`, `blog`, `link`, `alias` | yes |  |
| `id` | string | yes | Public ID, with the prd_ prefix. |
| `image` | string or null | yes |  |
| `lessons_count` | integer | yes |  |
| `modules_count` | integer | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `product` | yes |  |
| `offer` | object | no | Offer details of the product. Included only when the credentials have the products.read_offer permission. |
| `position` | integer | yes |  |
| `revision` | string | yes |  |
| `showcase_id` | string | yes | Public ID, with the shw_ prefix. |
| `status` | string, one of `published`, `draft`, `unlisted`, `hidden` | 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.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

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