# List banners

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

Operation ID: `banners.list` · API v3

Lists the content banners of the current account, ordered by position.

The collection can be filtered by `status`, `showcase_id`, and `deleted`. Trashed banners are excluded by default; set `deleted=true` to list only trashed banners.

Returns all matching banners in a single response while preserving the standard collection response format.

Required permissions: `banners.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `sort` | query | string, one of `position`, `-position` | no |  |
| `status` | query | string, one of `active`, `inactive` | no |  |
| `showcase_id` | query | string | no |  |
| `deleted` | query | boolean | no |  |

## Responses

### 200

Returns the collection of banners.

Body: `data`: array of Banner.

Fields of Banner:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `html` | string or null | no |  |
| `id` | string | yes | Public ID of the banner, prefixed with ban_. |
| `images` | object | yes |  |
| `link` | object | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `banner` | yes |  |
| `position` | integer | yes |  |
| `revision` | string | yes |  |
| `showcases` | array of string | yes |  |
| `status` | string, one of `active`, `inactive` | yes |  |
| `type` | string, one of `netflix`, `simple`, `html` | yes |  |
| `updated_at` | string (date-time) | yes |  |

### 400

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