Get Simulation Timeline | PaymentKit

Get simulation event timeline with pagination.

Returns events in chronological order (by virtual_timestamp).

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

external_idstringRequired

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Successful Response

itemslist of objects

totalinteger

has_moreboolean

422

Unprocessable Entity Error

1	{
2	"items": [
3	{
4	"event_type": "simulation_started",
5	"virtual_timestamp": "2024-01-15T09:30:00Z",
6	"entity_type": "simulation",
7	"entity_id": "sim-12345",
8	"payload": {
9	"initiated_by": "user_789",
10	"parameters": {
11	"duration": "2h",
12	"complexity": "high"
13	}
14	}
15	}
16	],
17	"total": 1,
18	"has_more": false
19	}

1	curl https://app.paymentkit.com/api/simulations/external_id/events \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json"