---
title: "List scenarios"
method: GET
path: "/simulate/scenarios"
tags: ["Onboarding Simulator"]
---

# List scenarios

`GET /simulate/scenarios`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/simulate/scenarios`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `accounts`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/simulate/scenarios/get.ts> (a function with typed inputs; its response is checked against the schema)

**Sandbox only** — not available in Production.

Returns all pre-defined scenarios available. Use the scenario IDs when calling the run scenario endpoint.

## Response `200`

Scenarios listed successfully

- SimulatorScenario[]
  - `id` string: The unique identifier of the scenario.
  - `name` string: Human-readable name of the scenario.
  - `description` string: Description of what the scenario does.
  - `action` string: The action type performed by this scenario.
  - `status` string: The resulting entity status after the scenario runs. Empty string for non-status actions.
  - `requirements_due` string[]: Requirement fields applied when the scenario runs, if any.

## Other responses

- `401`: Unauthorized
- `404`: Simulator not available in this environment. These endpoints are not registered in production.

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)