lumail.subscribers.listEvents

SDK 2.1.0 · API v2 · GET /api/v2/subscribers/:subscriber/events

MethodGET

/api/v2/subscribers/:subscriber/events

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.subscribers.listEvents(
  "[email protected]",
  { limit: 20, eventTypes: ["EMAIL_OPENED", "EMAIL_CLICKED"] },
);
if (error) {
  throw error;
}
for (const event of data.data) {
  console.log(event.eventType, event.createdAt);
}

Response Examples

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "evt_abc123",
      "eventType": "EMAIL_OPENED",
      "data": null,
      "subscriberId": "sub_abc123",
      "createdAt": "2026-09-05T10:30:00.000Z",
      "subscriber": {
        "id": "sub_abc123",
        "email": "[email protected]",
        "name": "Ada"
      }
    }
  ]
}

[email protected] · lumail.subscribers

subscribers.listEvents(idOrEmail: string, params?: ListEventsParams): Promise<LumailResult<ListEventsResponse>>

Events recorded on one contact. The SDK forwards limit, after, before, and eventTypes (JSON-stringified). order, startDate, endDate, and search are typed on ListEventsParams but are not forwarded.

Path Parameters

Name	Type	Description
`idOrEmail`	string	Required. Subscriber id or email.

Query Parameters

Name	Type	Description
`limit`	number	Page size. Forwarded.
`after`	string	Cursor: older events. Forwarded.
`before`	string	Cursor: newer events. Forwarded by the SDK.
`eventTypes`	`SubscriberEventType[]`	Filter by event type. Forwarded as a JSON string.
`order`	`"asc"` or `"desc"`	Typed only. Not forwarded by the SDK.
`startDate`	string	Typed only. Not forwarded by the SDK.
`endDate`	string	Typed only. Not forwarded by the SDK.
`search`	string	Typed only. Not forwarded by the SDK.

Response Fields

Field	Type	Description
`object`	`"list"`	Discriminator. Always `list`.
`has_more`	boolean	`true` when another page exists.
`data`	`SubscriberEvent[]`	Events. Each row: `id`, `eventType`, `data`, `subscriberId`, `createdAt`, `subscriber`.

data is { object, data, has_more }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.subscribers.removeTags Nextlumail.domains