PApaddlehq
Simulation runs

Get a run for a simulation

Changed on

Returns a simulation run using its ID.

Use the include parameter to include related entities in the response.

get/simulations/{simulation_id}/runs/{simulation_run_id}

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

simulation_idstring required

Paddle ID of the simulation entity to work with.

simulation_run_idstring required

Paddle ID of the simulation run entity to work with.

Query parameters

includeSimulationsRunIncludeEnum[]

Include related entities in the response.

Response

The request has succeeded.

Example response

{
  "data": {
    "id": "ntfsimrun_01ghbkd0frb9k95cnhwd1bxpvk",
    "created_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z",
    "events": [
      {
        "id": "ntfsimevt_01hvg8ykjrcdr4jvv9rqcbkhfa",
        "created_at": "2024-10-12T07:20:50.52Z",
        "updated_at": "2024-10-13T07:20:50.52Z"
      }
    ]
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

  • v1e1ac347eb3c5Revision changes
    • info

      api tag Simulations removed

  • v19ba8be0f2006Revision changes
    • breaking

      added the new path request parameter simulation_id

    • breaking

      added the new path request parameter simulation_run_id

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api tag Simulations added

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed from the response property oneOf list for the response status