# List Diamonds

`GET https://api.cademi.com.br/api/v3/automations/diamond`

Operation ID: `diamonds.list` · API v3

Returns the Diamonds accessible with the current credentials, paginated by cursor. Credentials scoped to specific showcases or products only see the Diamonds that belong to them.

The collection can be filtered by product, showcase, status, and deletion state.

Required permissions: `diamonds.read`.

## Parameters

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

## Responses

### 200

Returns a page of Diamonds.

Body: `data`: array of Diamond.

Fields of Diamond:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `delivery_id` | string or null | yes | Public ID of the Diamond's internal delivery, prefixed with dlv_. |
| `id` | string | yes | Public ID of the Diamond, prefixed with dmd_. |
| `lesson_ids` | array of string | yes | Public IDs of the Diamond's three lessons, in order. |
| `memberships_count` | integer | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `diamond` | yes |  |
| `product_id` | string or null | yes | Public ID of the Diamond's product, prefixed with prd_. |
| `revision` | string | yes |  |
| `settings` | object | yes |  |
| `showcase_id` | string or null | yes | Public ID of the source showcase, prefixed with shw_. |
| `status` | string, one of `active`, `inactive` | yes |  |
| `type` | string, one of `diamond` | 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.

### 409

Diamond automations are not enabled for the current account.

Body: Error.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

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