Skip to main content
GET
/
policies
/
{policyId}
/
events
{
  "data": [
    {
      "aggregateId": "<string>",
      "aggregateType": "PAYMENT_METHOD",
      "version": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "data": {},
      "metadata": {
        "rootId": "<string>",
        "branchId": "<string>",
        "tenantId": "<string>",
        "createdAt": "<string>",
        "productId": "<string>",
        "userId": "<string>",
        "isSimulated": true,
        "isCustomEvent": true,
        "appliedAt": "<string>",
        "migrated": true,
        "migrationId": "<string>"
      }
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}

Path Parameters

policyId
string
required

the policy id

Query Parameters

whenAt
string

Optional: the whenAt datetime

simulatedAt
string

Optional: the simulatedAt datetime

branchId
string

Optional: the branchId

Response

data
object[]
required

Array of policy events

total
number

Total number of policies

offset
number

Offset used for pagination

limit
number

Page size used for pagination