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

# Get Simulation

`GET /simulations/{simulation_id}`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/simulations/{simulation_id}`
- Auth: none declared

## Path parameters

- `simulation_id` string, uuid, required

## Response `200`

Successful Response

- SimulationWithLinks
  - `url` string, nullable
  - `api_url` string, nullable
  - `id` string, required: The unique identifier for the simulation.
  - `created_at` string, date-time, required: Timestamp of when the simulation was created.
  - `updated_at` string, date-time, nullable: Timestamp of when the simulation was last updated.
  - `experiment_id` string, required: The ID of the experiment this simulation belongs to.
  - `project_id` string, nullable: The project the simulation belongs to: its experiment's project.
  - `parameterized_model_id` string, required: The ID of the parameterized model used for this simulation.
  - `design_id` string, nullable: The ID of the design for this simulation.
  - `job_id` string, nullable: The ID of the job running this simulation.
  - `status` string, nullable: The current status of the job running this simulation.
  - `error` string, nullable: Error message if the job failed.
  - `error_code` string, nullable: Machine-readable error code.
  - `metrics` object, nullable: Computed metrics from the simulation.
  - `simulation_options` object, nullable: Options the simulation was run with; part of its identity, so a rerun must send them back.
  - `storage_folder` string, nullable: Folder path in storage containing simulation files (solution.parquet, time_series.parquet, steps.parquet).
  - `organization_id` string, required: Organization this simulation belongs to.
  - `experiment` object, nullable: The experiment this simulation belongs to (id and template).
  - `parameterized_model` object, nullable: The parameterized model (id and name only).
  - `design` object, nullable: The design used for this simulation.
  - `protocol_id` string, nullable: The saved protocol (experiment template) the simulation ran; the same id the run and list endpoints take as a protocol.
  - `protocol_name` string, nullable: That protocol's name.
  - `parameters` object, nullable: Resolved parameters for the simulation.
  - `simulation_data` object, nullable: The data from the simulation (time_series, steps).

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-28** `3abf50e2d741`: 1 breaking, 24 info
  - the response's body type changed from no type to `object` for status `200`
  - added the optional property `api_url` to the response with the `200` status
  - added the optional property `design` to the response with the `200` status
  - added the optional property `design_id` to the response with the `200` status
  - …21 more
- **2026-09-30** `ea3d377fec1a`: 1 breaking
  - for the `path` request parameter `simulation_id`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/simulations/:simulation_id/get.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)