GET /simulations

Retrieves a list of simulations.

Request

keyoptional

Filter simulations by key. When provided, returns only the simulation with the matching key.

limitoptional

Maximum number of simulations to return. Must be an integer between 1 and 100. Defaults to 10.

offsetoptional

Number of simulations to skip. Must be an integer greater than or equal to 0. Defaults to 0.

Success

Responds with a 200 OK and an array of simulations.

keyrequired

A unique identifier.

parentoptional

The key of the parent simulation, if any.

seedoptional

The seed for the simulation's random number generator. Must be an integer greater than or equal to 1.

createdAtrequired

The timestamp when the simulation was created.

updatedAtrequired

The timestamp when the simulation was last updated.

Example

Request to get the first 2 simulations:

GET /simulations?limit=2

Response:

[
  {
    "key": "default",
    "seed": 1,
    "createdAt": "2025-04-15T10:30:00.000Z",
    "updatedAt": "2025-04-15T10:30:00.000Z"
  },
  {
    "key": "user-simulation",
    "parent": "default",
    "seed": 42,
    "createdAt": "2025-04-16T14:22:15.123Z",
    "updatedAt": "2025-04-16T14:22:15.123Z"
  }
]