List simulations
Returns a paginated list of simulations. Use the query parameters to page through results.
Query Parameters
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.
Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination IDs.
Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].
Valid fields for ordering: id.
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.
Return only the IDs specified. Use a comma-separated list to get multiple entities.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Response
Represents a simulation entity.
Unique Paddle ID for this simulation, prefixed with ntfsim_.
Whether this entity can be used in Paddle.
Paddle ID of the notification setting where this simulation is sent, prefixed with ntfset_.
Name of this simulation.
Single event sent for this simulation, in the format entity.event_type.
Simulation payload.
RFC 3339 datetime string of when this simulation was last run. null until run. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.