List policy events

Retrieve the chronological history of events that have occurred on a policy, such as the policy being issued, updated, lapsed, or having a note or attachment added.

Events are returned as a JSON array ordered by created_at, newest first. This endpoint is not paginated — the full set of matching events is returned in a single response. Use the created_at and version range filters to narrow the result set.

Every event shares a common envelope (policy_id, type, event_version, created_at, requested_by, and metadata). Each event also carries additional fields specific to its type (for example, a policy_issued event includes premium and cover details, while a policy_schedule_updated event includes a policy_schedule_uri). Those type-specific fields are not enumerated here and may be added over time, so clients should not assume a fixed set of fields per event type.

Path Params
string
required

Must be a UUID. The unique identifier of the policy.

Query Params
date-time

Only return events created at or after this time. Must be an ISO 8601 date-time string.

date-time

Only return events created at or before this time. Must be an ISO 8601 date-time string.

integer
≥ 0

Only return events at or after this policy aggregate version.

integer
≥ 0

Only return events at or before this policy aggregate version.

include
array of strings

Deprecated and retained for backwards compatibility only. Accepts the value policy but has no effect on the response.

include
Allowed:
Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json