Skip to main content
GET
/
simulations
/
{simulation_id}
/
runs
/
{simulation_run_id}
Get a run for a simulation
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/simulations/{simulation_id}/runs/{simulation_run_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "ntfsimrun_01j82h13n87yq2sfv187hm2r0p",
    "status": "completed",
    "type": "subscription_creation",
    "created_at": "2024-09-18T12:17:04.168467Z",
    "updated_at": "2024-09-18T12:17:17.663481Z"
  },
  "meta": {
    "request_id": "eb5331b5-496d-41ed-9e15-dce968e3bbc6"
  }
}

Authorizations

​
Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

​
simulation_id
string
required

Paddle ID of the simulation entity to work with.

Example:

"ntfsim_01gt261ms8ew72a0vnm5p5ne2q"

​
simulation_run_id
string
required

Paddle ID of the simulation run entity to work with.

Example:

"ntfsimrun_01gt261ms8ew72a0vnm5p5ne2q"

Query Parameters

​
include
enum<string>[]

Include related entities in the response.

Available options:
events

Response

OK

​
data
Single event run · object
required

Single event simulations play a single event.

​
meta
Meta · object
required

Information about this response.