# ListEventsOptions

Options for listing events in a Book.

### afterDate?

```ts
optional afterDate: string;
```

The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.

***

### beforeDate?

```ts
optional beforeDate: string;
```

The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.

***

### cursor?

```ts
optional cursor: string;
```

The cursor for pagination.

***

### limit

```ts
limit: number;
```

The maximum number of events to return.

Defaults to `50`, maximum is `200`.

***

### onError?

```ts
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?

```ts
optional resourceId: string;
```

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

When set, `onError` and `type` are ignored.

***

### type?

```ts
optional type: EventType;
```

The event type to filter by.

Ignored when `resourceId` or `onError` is set.