ListEventsOptions

Options for listing events in a Book.

Properties

afterDate?

optional afterDate: string;

The start date (inclusive) for the events search range, in RFC3339 format.

---

beforeDate?

optional beforeDate: string;

The end date (exclusive) for the events search range, in RFC3339 format.

---

cursor?

optional cursor: string;

The cursor for pagination.

---

limit

limit: number;

The maximum number of events to return.

Defaults to 50, maximum is 200.

---

onError?

optional onError: boolean;

Whether to filter events by error responses.

true returns events with at least one error response. false returns events with no error responses. null or undefined includes events regardless of error responses.

Ignored when resourceId is set. When set, type is ignored.

---

resourceId?

optional resourceId: string;

The ID of the event’s resource (Transaction, Account, or Group).

When set, onError and type are ignored.

---

type?

optional type: EventType;

The event type to filter by.

Ignored when resourceId or onError is set.