# Retrieve a test scenario

`GET https://api.cademi.com.br/api/v3/sandbox/test-scenarios/{scenario_id}`

Operation ID: `sandbox.test_scenarios.get` · API v3

Retrieves a test scenario from the sandbox catalog, including the parameters it accepts and the effects it produces. Scenario IDs use the `scn_` prefix.

Required permissions: `sandbox.read`.

## Parameters

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

## Responses

### 200

Returns the requested test scenario.

Body: `data`: TestScenario.

Fields of TestScenario:

| Field | Type | Required | Description |
|---|---|---|---|
| `description` | string | yes |  |
| `effects` | array of string | yes | Resources the scenario creates, events it emits, and emails it simulates. |
| `id` | string | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `test_scenario` | yes |  |
| `params` | object | yes | Schema of the parameters accepted when running the scenario. May be an empty object. |
| `version` | integer | 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

No test scenario exists with the supplied ID.

Body: Error.

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