lumail.subscribers.list

SDK 2.1.0 · API v2 · GET /api/v2/subscribers

MethodGET

/api/v2/subscribers

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.subscribers.list({
  limit: 50,
  query: "ada@",
});
if (error) {
  throw error;
}
for (const subscriber of data.data) {
  console.log(subscriber.email, subscriber.status);
}

Response Examples

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "sub_abc123",
      "email": "[email protected]",
      "name": "Ada",
      "status": "SUBSCRIBED",
      "createdAt": "2026-09-05T10:30:00.000Z",
      "tags": [{ "id": "tag_abc", "name": "newsletter" }]
    }
  ]
}

[email protected] · lumail.subscribers

subscribers.list(params?: ListSubscribersParams): Promise<LumailResult<ListSubscribersResponse>>

Filter with query, status, tag, limit, after, before.

Query Parameters

SubscriberStatus: PENDING_CONFIRMATION, SUBSCRIBED, UNSUBSCRIBED, BOUNCED, BANNED, COMPLAINED, TRANSACTIONAL.

Name	Type	Description
`limit`	number	Page size.
`after`	string	Cursor: return contacts after this id.
`before`	string	Cursor: return contacts before this id. Forwarded by the SDK.
`tag`	string	Filter by tag name.
`status`	`SubscriberStatus` or `"all"`	Filter by status. `all` returns every status.
`query`	string	Search string (email or name).

Response Fields

Field	Type	Description
`object`	`"list"`	Discriminator. Always `list`.
`has_more`	boolean	`true` when another page exists.
`data`	`ListSubscriberEntry[]`	Contacts, newest first. Each row: `id`, `email`, `name`, `status`, `createdAt`, `tags`.

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

Previouslumail.subscribers Nextlumail.subscribers.create