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

fetch('https://api.paddle.com/simulations/{simulation_id}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": [
    {
      "id": "ntfsimrun_01j82gvz2cgw08p7mak3gcd3a3",
      "status": "completed",
      "type": "subscription_creation",
      "created_at": "2024-09-18T12:14:15.628606Z",
      "updated_at": "2024-09-18T12:14:27.244695Z"
    },
    {
      "id": "ntfsimrun_01j82gjx7fxdc27bsqxf311cbe",
      "status": "completed",
      "type": "subscription_creation",
      "created_at": "2024-09-18T12:09:18.831870Z",
      "updated_at": "2024-09-18T12:09:30.613445Z"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 50,
      "estimated_total": 2,
      "next": "https://api.paddle.dev/simulations/ntfsim_01j82d9tc19c67jds5vzbzjcns/runs?after=ntfsimrun_01j82gjx7fxdc27bsqxf311cbe",
      "has_more": false
    },
    "request_id": "12a52c1d-e899-4401-baf4-e836e3178062"
  }
}

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"

Query Parameters

​
after
string

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

​
include
enum<string>[]

Include related entities in the response.

Available options:
events
​
order_by
string
default:id[DESC]

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

​
per_page
integer
default:50

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

Required range: x <= 200
​
id
string[]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

Response

OK

​
data
(Single event run · object | Scenario run · object)[]
required

Single event simulations play a single event.

​
meta
MetaPaginated · object
required

Information about this response.