# List showcases

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

Operation ID: `showcases.list` · API v3

Lists showcases and showcase groups in the account, ordered by position and paginated with a cursor.

By default, only top-level items are returned; use `parent_id` to list the showcases inside a group. The collection can also be filtered by `status`, `kind`, and name (`q`). Set `deleted=true` to list showcases in the trash instead of active ones.

Credentials limited to specific showcases only see those showcases.

Required permissions: `showcases.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `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`, `unlisted`, `hidden` | no |  |
| `kind` | query | string, one of `group`, `showcase` | no |  |
| `deleted` | query | boolean | no |  |
| `q` | query | string | no |  |

## Responses

### 200

Returns a page of showcases.

Body: `data`: array of Showcase.

Fields of Showcase:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `id` | string | yes | Public ID, with the shw_ prefix. |
| `image` | string or null | yes |  |
| `kind` | string, one of `group`, `showcase` | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `showcase` | yes |  |
| `parent_id` | string or null | yes |  |
| `position` | integer | yes |  |
| `products_count` | integer | yes |  |
| `revision` | string | yes |  |
| `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