List Subscribers

List contacts newest first. Paginate with cursor.

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: 20,
  status: "SUBSCRIBED",
});
if (error) {
  throw error;
}

for (const subscriber of data.data) {
  console.log(subscriber.id, subscriber.email);
}

if (data.has_more) {
  const next = await lumail.subscribers.list({
    limit: 20,
    after: data.data.at(-1)?.id,
  });
  console.log(next.data?.data.length);
}

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_abc123", "name": "newsletter" }]
    }
  ]
}

Lists contacts newest first. Permission: subscribers.

Query Parameters

Name	Type	Description
`limit`	integer	Page size. Default `50`. Min `1`, max `100`.
`after`	string	Subscriber id cursor. Next page, older than this id.
`status`	string	Filter: `SUBSCRIBED`, `PENDING_CONFIRMATION`, `UNSUBSCRIBED`, `BOUNCED`, `BANNED`, `COMPLAINED`, `TRANSACTIONAL`, or `all`.
`tag`	string	Filter by tag name (case-insensitive).
`query`	string	Search email or name.

after is a subscriber id from the previous page.

Response Fields

Field	Type	Description
`object`	`"list"`	Discriminator. Always `list`.
`has_more`	boolean	`true` when another page exists.
`data`	array	Subscriber rows: `id`, `email`, `name`, `status`, `createdAt`, `tags`.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `subscribers` permission

PreviousSubscribers NextCreate Subscriber

Query Parameters

Response Fields

Errors

Related