---
title: "Get simulation scenario versions"
method: GET
path: "/v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/"
tags: ["Simulation"]
---

# Get simulation scenario versions

`GET /v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/`

Retrieve the versions of a simulation scenario.

#### Permissions
This endpoint requires the following permissions:
- `Simulation:GetSimulationScenario` for the simulation scenario.

## Path parameters

- `organization` string, required
- `simulation_scenario_id` string, required — The ID of the simulation scenario to get versions for.

## Query parameters

- `version` string, nullable — The versions of the simulation scenario to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.
- `limit` integer — The maximum number of simulation scenario versions to return.
- `continuation_token` integer — The continuation token from the previous request used to retrieve the next page of simulation scenario version.
- `sort_by` string[] — The fields to sort the versions by. Supported fields are `version`. Specify a `+` before the field name to indicate ascending sorting and `-` for descending sorting. Multiple fields can be specified to break ties.

## Headers

- `x-mongo-cluster-name` string, nullable — The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
- `Sec-WebSocket-Protocol` string[]

## Response `200`

Succeeded.

- SrcAppEndpointsSimulationGetSimulationScenarioVersionsResponse
  - `simulation_scenario_versions` SimulationScenarioVersion[], required — The list of simulation scenario versions.
    - `_id` string, required — The ID of the document.
    - `org_id` string, required — The ID of the organization.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `simulation_scenario_id` string, required — The ID of the simulation scenario that this is a version of.
    - `version` integer, required — The version number of the simulation scenario.
    - `objective` string, required — The objective of the simulation scenario.
    - `instructions` string, required — The instructions for the simulation scenario.
    - `initial_message_type` 'user-message' | 'external-event' | 'skip', required
    - `conversation_starts_at` string, date-time, nullable, required — The time at which the conversation starts. This must be a timestamp in UTC. If not specified, the current server time is used.
    - `creator` AmigoLibMongoCollectionsSimulationScenarioVersionSimulationScenarioVersionUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
  - `has_more` boolean, required — Whether there are more simulation scenario versions to fetch.
  - `continuation_token` unknown, required

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — The specified organization or simulation scenario does not exist.
- `422` — Invalid request path parameter or request query parameter failed validation.
- `429` — The user has exceeded the rate limit of 500 requests per minute for this endpoint.
- `503` — The service is going through temporary maintenance.

---

[API](https://skmtc.net/amigo/apis/amigo-api.md) · [All operations](https://skmtc.net/amigo/apis/amigo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/amigo/amigo-api/revisions/f0f28319e448/schema)