---
title: "Get a list of events"
method: GET
path: "/event"
tags: ["Events"]
---

# Get a list of events

`GET /event`

Return a page of events from the stream.

Supports cursor-based pagination with an optional timestamp lower bound.

## Query parameters

- `start_cursor` string, nullable — Return events after this cursor (exclusive)
- `end_cursor` string, nullable — Return events up to and including this cursor
- `min_created_at` string, date-time, nullable — Return events created after this timestamp. ISO 8601 datetime in any timezone. When using a timezone offset, percent-encode the + as %2B (e.g. %2B01:00), or use the Z suffix for UTC.
- `limit` integer — Max events to return

## Response `200`

Event stream with pagination

- EventsResponse — Response for GET /event.
  - `events` union[], required
    - union
      - SubscribedEvent — A new holding subscription was placed.
        - `cost` string, decimal, required — Principal amount invested in the holding's currency.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'SUBSCRIBED', required
        - `holdingUid` string, required — Unique identifier of the holding.
        - `maturityDate` string, required — Date (YYYY-MM-DD) the holding is scheduled to mature.
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `productCode` string, required — Identifier of the product this holding is in.
        - `subscriptionDate` string, required — Date (YYYY-MM-DD) the subscription was originally placed.
        - `subscriptionUid` string, required — Unique identifier of the subscription.
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - IssuedEvent — A holding was issued (moved from subscription to active).
        - `cost` string, decimal, required — Principal amount invested in the holding's currency.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'ISSUED', required
        - `holdingUid` string, required — Unique identifier of the holding.
        - `issueDate` string, required — Date (YYYY-MM-DD) the holding was issued.
        - `maturityDate` string, required — Date (YYYY-MM-DD) the holding is scheduled to mature.
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `productCode` string, required — Identifier of the product this holding is in.
        - `subscriptionUid` string, required — Unique identifier of the subscription.
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - SplitEvent — A holding was split into two separate holdings.
        - `cost` string, decimal, required — Remaining principal amount on the original holding after the split.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'SPLIT', required
        - `holdingUid` string, required — Unique identifier of the original holding.
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `splitCost` string, decimal, required — Principal amount assigned to the new holding created by the split.
        - `splitHoldingUid` string, required — Unique identifier of the new holding created by the split.
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - ExtendedEvent — A holding's maturity date was extended.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'EXTENDED', required
        - `extensionOptionDate` string, nullable — Updated extension option date (YYYY-MM-DD) after the change. Null if none applies.
        - `holdingUid` string, required — Unique identifier of the holding.
        - `maturityDate` string, required — Updated maturity date (YYYY-MM-DD) after the extension.
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `previousExtensionOptionDate` string, nullable — Extension option date (YYYY-MM-DD) before the change. Null if none was previously set.
        - `previousMaturityDate` string, required — Maturity date (YYYY-MM-DD) before the extension.
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - FinalizedEvent — A holding was confirmed as closed at maturity.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'FINALIZED', required
        - `finalized` boolean, required — Always true — confirms the holding is closed at maturity.
        - `holdingUid` string, required — Unique identifier of the holding.
        - `maturityDate` string, required — Date (YYYY-MM-DD) the holding matured.
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - AdjustedEvent — One or more holding attributes were amended.
        - `cost` string, decimal, required — Updated principal amount in the holding's currency.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'ADJUSTED', required
        - `holdingUid` string, required — Unique identifier of the holding.
        - `maturityDate` string, required — Updated maturity date (YYYY-MM-DD).
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `previousMaturityDate` string, required — Maturity date (YYYY-MM-DD) before the amendment.
        - `previousMaturityValue` string, decimal, required — Expected maturity value before the amendment.
        - `previousSubscriptionDate` string, required — Subscription date (YYYY-MM-DD) before the amendment.
        - `subscriptionDate` string, required — Updated subscription date (YYYY-MM-DD).
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - CurrencyConvertedEvent — Cash was converted from one currency to another.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'CURRENCY_CONVERTED', required
        - `fromAmount` string, decimal, required — Amount in the source currency before conversion.
        - `fromCurrency` string, required — Source currency code.
        - `fxRate` string, decimal, required — Exchange rate applied in the conversion.
        - `toAmount` string, decimal, required — Amount in the target currency after conversion.
        - `toCurrency` string, required — Target currency code.
        - `uid` string, required — Unique identifier for this event record.
      - CashMovedEvent — Cash was deposited into or withdrawn from the client's account.
        - `amount` string, decimal, required — Net cash amount. Positive indicates a deposit; negative indicates a withdrawal.
        - `currency` string, required — Three-letter currency code for the cash movement.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'CASH_MOVED', required
        - `uid` string, required — Unique identifier for this event record.
      - RedeemedEvent — A holding was redeemed at maturity and proceeds were returned to the client.
        - `cost` string, decimal, required — Principal amount that was invested.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'REDEEMED', required
        - `fxCurrency` string, nullable — Currency in which the redemption proceeds were paid out, when this differs from the holding's currency (FX redemption). Null for standard same-currency redemptions.
        - `fxValue` string, decimal, nullable — Amount paid out in fxCurrency. Null for standard same-currency redemptions.
        - `holdingUid` string, required — Unique identifier of the holding.
        - `maturityValue` string, decimal, required — Expected or actual maturity value (principal plus interest) in the holding's currency.
        - `obligorExposureCode` string, required — Code identifying the obligor exposure (counterparty) for this holding.
        - `uid` string, required — Unique identifier for this event record.
        - `yield` string, decimal, required — Current yield for the holding at the time of the event (annualised APY).
      - CancelledEvent — A previously issued holding was cancelled.
        - `cost` string, decimal, required — Principal amount that was invested in the cancelled holding.
        - `currency` string, required — Three-letter currency code for the holding.
        - `cursor` string, required — Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.
        - `entityCode` string, required — Code identifying the organisation (client) this event belongs to.
        - `eventType` 'CANCELLED', required
        - `holdingUid` string, required — Unique identifier of the cancelled holding.
        - `uid` string, required — Unique identifier for this event record.
  - `pageInfo` EventPageInfo, required — Pagination metadata for cursor-based event queries.
    - `endCursor` string, nullable — Stable fence cursor representing the head of the stream at the time of the request. Use this as end_cursor on subsequent requests to retrieve only new events.
    - `hasNextPage` boolean, required — True if there are more events beyond the current page.
    - `limit` integer, required — Maximum number of events returned per request.
    - `pageEndCursor` string, nullable — Cursor of the last event on the current page. Pass as start_cursor to fetch the next page.
    - `startCursor` string, nullable — Cursor of the first event on the current page.
    - `totalCount` integer, nullable — Total number of events matching the current filters and cursor range.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/treasuryspring/apis/treasuryspring-public-api.md) · [All operations](https://skmtc.net/treasuryspring/apis/treasuryspring-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/treasuryspring/treasuryspring-public-api/versions/d587dda25444/schema)