---
title: "Get Simulation"
method: GET
path: "/workflows/v1/simulations/{simulation_id}"
tags: ["Simulations"]
---

# Get Simulation

`GET /workflows/v1/simulations/{simulation_id}`

Endpoint to retrieve a simulation by its ID.

## Path parameters

- `simulation_id` string, required

## Response `200`

Successful Response

- SimulationResponse — Response model for a single simulation. Contains a SimulationConfigModel object.
  - `simulation` SimulationConfigModel, required — Stores the simulation configurations in the workflow system.
    - `team_id` string, nullable — ID of the team that owns this edge
    - `created_by` string, nullable — ID of the user who created this edge
    - `updated_by` string, nullable — ID of the user who last updated this edge
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `_id` string
    - `simulation_config` SimulationConfigOutput
      - `logical_id` string, nullable — Unique identifier for the simulation
      - `status` 'pending' | 'running' | 'completed' | 'failed' | 'cancelled', nullable — Current status of the simulation
      - `name` string, nullable — Name of the simulation
      - `description` string, nullable — Description of the simulation
      - `selected_workflow` object, nullable — Details about the selected workflow execution
        - `workflow_id` string, nullable — DB Object ID of the workflow this simulation is associated with
        - `version_number` integer, nullable — Version number of the workflow this simulation is associated with. 0 is the initial version (default).
        - `version_name` string, nullable — Version name of the workflow this simulation is associated with
        - `dynamic_variables` object, nullable — Dynamic variables to apply to the workflow
        - `name` string, nullable — Name of the selected workflow
        - `total_events` integer, nullable — Total number of events processed in the selected workflow
        - `total_nodes` integer, nullable — Total number of nodes in the selected workflow
        - `total_duration_seconds` integer, nullable — Total duration in seconds for the selected workflow
        - `run_id` string, nullable — Workflow Run ID of the executed workflow
      - `counter_workflow` object, nullable — Details about the counter workflow execution
        - `workflow_id` string, nullable — DB Object ID of the workflow this simulation is associated with
        - `version_number` integer, nullable — Version number of the workflow this simulation is associated with. 0 is the initial version (default).
        - `version_name` string, nullable — Version name of the workflow this simulation is associated with
        - `dynamic_variables` object, nullable — Dynamic variables to apply to the workflow
        - `name` string, nullable — Name of the selected workflow
        - `total_events` integer, nullable — Total number of events processed in the selected workflow
        - `total_nodes` integer, nullable — Total number of nodes in the selected workflow
        - `total_duration_seconds` integer, nullable — Total duration in seconds for the selected workflow
        - `run_id` string, nullable — Workflow Run ID of the executed workflow
      - `timeout_seconds` integer, nullable — Maximum time in seconds to run the simulation
      - `max_events` integer, nullable — Maximum number of events to process in the simulation
      - `number_of_simulations` integer, nullable — Number of times to run the simulation
      - `max_concurrent_runs` integer, nullable — Maximum number of concurrent simulation runs allowed
      - `assistant_starts_first` boolean, nullable — If True, the assistant workflow will kick off first, else it will be the user workflow.
      - `stop_on_failure` boolean, nullable — Whether to stop the simulation on failure
      - `run_by` string, nullable — Identifier of the user or system that initiated the workflow simulation

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/interactly/apis/interactly-api-3.md) · [All operations](https://skmtc.net/interactly/apis/interactly-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactly/interactly-api-3/versions/9f4e7dc7e094/schema)