# Retrieve a Diamond

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

Operation ID: `diamonds.get` · API v3

Retrieves a Diamond with its settings and the IDs of its related product, showcase, delivery, and lessons.

The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the Diamond or one of its stages to avoid overwriting a newer version.

Required permissions: `diamonds.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `diamond_id` | path | string | yes |  |

## Responses

### 200

Returns the requested Diamond.

Body: `data`: 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 |  |

### 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 Diamond was not found or is not accessible with the current credentials.

Body: Error.

### 409

Diamond automations are not enabled for the current account.

Body: Error.

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