# GET /simulations

**List simulations**

Returns a paginated list of simulations. Use the query parameters to [page through results](https://developer.paddle.com/api-reference/about/pagination).

**Required permissions:** `notification_simulation.read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | array | optional | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| `after` | string | optional | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses for list operations. |
| `per_page` | integer | optional | 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`. (Max: 200) |
| `notification_setting_id` | array | optional | Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination IDs. |
| `order_by` | string | optional | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`.

Valid fields for ordering: `id`. |
| `status` | array | optional | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |

## Response (200)

- `data`: array (required)
- `meta`: object (required) — Information about this response.
  - `request_id`: string (required) — Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
  - `pagination`: object (required) — Keys used for working with paginated results.
    - `per_page`: integer (required) — Number of entities per page for this response. May differ from the number requested if the requested number is greater than the maximum.
    - `next`: string (uri) (required) — URL containing the query parameters of the original request, along with the `after` parameter that marks the starting point of the next page. Always returned, even if `has_more` is `false`.
    - `has_more`: boolean (required) — Whether this response has another page.
    - `estimated_total`: integer — Estimated number of entities for this response.

### Response example

```json
{
  "data": [
    {
      "id": "ntfsim_01j82fs5pvrdse93e1kawqy2fr",
      "notification_setting_id": "ntfset_01j8259dtga48jwekrv2pmk0kp",
      "name": "Refund or chargeback created",
      "type": "adjustment.created",
      "status": "active",
      "payload": null,
      "config": null,
      "last_run_at": "2024-09-18T11:55:18.261049Z",
      "created_at": "2024-09-18T11:55:15.547675Z",
      "updated_at": "2024-09-18T11:55:18.261225Z"
    },
    {
      "id": "ntfsim_01j82d9tc19c67jds5vzbzjcns",
      "notification_setting_id": "ntfset_01j82d983j814ypzx7m1fw2jpz",
      "name": "Subscription created using pricing page on website",
      "type": "subscription_creation",
      "status": "active",
      "payload": null,
      "config": {
        "subscription_cancellation": null,
        "subscription_creation": {
          "entities": {
            "customer_id": null,
            "address_id": null,
            "business_id": null,
            "payment_method_id": null,
            "discount_id": null,
            "transaction_id": null,
            "items": null
          },
          "options": {
            "customer_simulated_as": "existing_email_matched",
            "business_simulated_as": "not_provided",
            "discount_simulated_as": "not_provided"
          }
        },
        "subscription_pause": null,
        "subscription_renewal": null,
        "subscription_resume": null
      },
      "last_run_at": null,
      "created_at": "2024-09-18T11:11:55.265125Z",
      "updated_at": "2024-09-18T11:54:18.543265Z"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 50,
      "estimated_total": 2,
      "next": "https://api.paddle.dev/simulations?after=ntfsim_01j55cce7pz60k2a4dfeh1c9sa",
      "has_more": false
    },
    "request_id": "ad095054-41bc-4907-907d-da18310aea49"
  }
}
```
