---
title: "Search simulation scenarios"
method: GET
path: "/v1/{organization}/simulation/scenario/search"
tags: ["Simulation"]
---

# Search simulation scenarios

`GET /v1/{organization}/simulation/scenario/search`

Search for simulation scenarios that match the given filters and contain the given query in its name. Only the top 50 results will be returned. The results
will be sorted by the relevance of the search query.

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

## Path parameters

- `organization` string, required

## Query parameters

- `query` string, required
- `creator` string[] — The creators of the simulation scenarios. Each value must be of the format `org_id,user_id`.
- `tag` string[] — The tags of the simulation scenarios. Must be specified using the syntax `key:value`, which means to match all sets with the given `key` and `value` pair among its tags. If `value` is `*`, it means the `value` does not matter. If `value` is empty, it matches against when the value is `None`.

## 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.

- SrcAppEndpointsSimulationSearchSimulationScenariosResponse
  - `simulation_scenarios` SimulationScenarioInstance[], required — The list of simulation scenarios.
    - `id` string, required — The ID of the simulation scenario.
    - `name` string, required — The name of the simulation scenario.
    - `tags` object, required — The tags of the simulation scenario.
    - `is_deleted` boolean, required — Whether the simulation scenario is deleted.
    - `created_at` string, date-time, required — The timestamp when the simulation scenario was created.
    - `creator` AmigoLibMongoCollectionsSimulationScenarioSimulationScenarioUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
    - `updated_at` string, date-time, required — The timestamp when the simulation scenario was last updated.
    - `updated_by` AmigoLibMongoCollectionsSimulationScenarioSimulationScenarioUserInfo, required
      - `org_id` string, required
      - `user_id` string, required

## 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)