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

# Get simulation persona versions

`GET /v1/{organization}/simulation/persona/{simulation_persona_id}/version/`

Retrieve versions of a simulation persona.

#### Permissions
This endpoint requires the following permissions:
* `Simulation:GetSimulationPersona` for the simulation persona.

## Path parameters

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

## Query parameters

- `version` string, nullable — The versions of the simulation persona 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 persona versions to return.
- `continuation_token` integer — The continuation token from the previous request used to retrieve the next page of simulation persona versions.
- `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.

- SrcAppEndpointsSimulationGetSimulationPersonaVersionsResponse
  - `simulation_persona_versions` SimulationPersonaVersion[], required — The simulation persona versions of the simulation persona.
    - `_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_persona_id` string, required — The ID of the simulation persona that this is a version of.
    - `version` integer, required — The version number of the simulation persona.
    - `background` string, required — The background of the simulation persona.
    - `preferred_language` string, nullable, required — The preferred language of the simulation persona in the ISO 639-3 format. If unspecified, the language of the agent is used.
    - `timezone` string, nullable, required — The timezone of the simulation persona in the IANA tz database format. If unspecified, UTC is used.
    - `user_models` string[], required — The user models associated with the simulation persona.
    - `nonsensitive_user_variables` object, required — A dictionary of the simulation persona's nonsensitive user variables that are provided to the tools.
    - `sensitive_user_variables` object — A dictionary of the simulation persona's sensitive user variables that are provided to the tools. Unlike the ones in the user collection, these are not encrypted, so only sensitive information in staging environment should be stored here.
    - `creator` AmigoLibMongoCollectionsSimulationPersonaVersionSimulationPersonaVersionUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
  - `has_more` boolean, required — Whether there are more simulation persona versions to fetch.
  - `continuation_token` unknown, required

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — The specified organization or simulation persona does not exist.
- `422` — Invalid request path parameter or request query parameter failed validation.
- `429` — The user has exceeded the rate limit of 50 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)
