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

# Get simulation personas

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

Retrieve simulation personas that match the given filters.

#### Permissions
This endpoint may be impacted by the following permissions:
* Only simulation personas that the authenticated user has `Simulation:GetSimulationPersona` permission for will be retrieved.

## Path parameters

- `organization` string, required

## Query parameters

- `id` string[] — The IDs of the simulation personas to retrieve.
- `limit` integer — The maximum number of simulation personas to return.
- `continuation_token` integer — The continuation token from the previous request used to retrieve the next page of simulation personas.
- `is_deleted` boolean, nullable — Whether the simulation persona is deleted.
- `role` string[] — The roles of the simulation personas.
- `creator` string[] — The creators of the simulation personas to retrieve. Each value must be of the format `org_id,user_id`.
- `tag` string[] — The tags of the simulation personas to retrieve. Each value must be of the format `key:value`. If `value` is `*`, it means the `value` does not matter. If `value` is empty, it matches against when the value is `None`.
- `sort_by` string[] — The fields to sort the sets by. Supported fields are `updated_at`. 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.

- SrcAppEndpointsSimulationGetSimulationPersonasResponse
  - `simulation_personas` SimulationPersonaInstance[], required — The list of simulation personas.
    - `id` string, required — The ID of the simulation persona.
    - `name` string, required — The name of the simulation persona.
    - `role` string, required — The role of the simulation persona.
    - `tags` object, required — The tags of the simulation persona.
    - `is_deleted` boolean, required — Whether the simulation persona is deleted.
    - `created_at` string, date-time, required — The timestamp when the simulation persona was created.
    - `creator` AmigoLibMongoCollectionsSimulationPersonaSimulationPersonaUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
    - `updated_at` string, date-time, required — The timestamp when the simulation persona was last updated.
    - `updated_by` AmigoLibMongoCollectionsSimulationPersonaSimulationPersonaUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
  - `has_more` boolean, required — Whether there are more simulation personas to fetch.
  - `continuation_token` unknown, required
  - `filter_values` SrcAppEndpointsSimulationGetSimulationPersonasResponseFilterValues, required
    - `creators` AmigoLibMongoCollectionsSimulationPersonaSimulationPersonaUserInfo[], required — The list of users who created the simulation personas.
      - `org_id` string, required
      - `user_id` string, required
    - `tags` string[], required — The list of tags of the simulation personas.
    - `roles` string[], required — The list of roles of the simulation personas.

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — Specified organization is not found.
- `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)