# Retrieve the sandbox

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

Operation ID: `sandbox.get` · API v3

Describes the sandbox associated with the current credentials.

With production credentials, the response describes the linked sandbox. If no sandbox has been provisioned, the request still succeeds and `status` is `absent`. With sandbox credentials, the response describes the sandbox itself.

Required permissions: `sandbox.read`.

## Responses

### 200

Returns the current state of the sandbox.

Body: `data`: Sandbox.

Fields of Sandbox:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string or null (date-time) | yes |  |
| `environment` | string, one of `production`, `sandbox` | yes | Environment of the requesting credentials. |
| `last_reset_at` | string or null (date-time) | yes |  |
| `last_reset_operation_id` | string or null | yes | Public ID of the operation that performed the last reset, with the op_ prefix. |
| `linked` | boolean | yes | For production credentials, whether a sandbox is linked to the account. For sandbox credentials, indicates that the credentials already belong to the sandbox. |
| `object` | string, one of `sandbox` | yes |  |
| `scenario` | object or null | yes |  |
| `status` | string, one of `ready`, `resetting`, `absent` | 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.

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