lumail.subscribers.get

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

MethodGET

/api/v2/subscribers/:subscriber

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.subscribers.get("[email protected]");
if (error) {
  throw error;
}
console.log(data.id, data.status);

Response Examples

{
  "id": "sub_abc123",
  "email": "[email protected]",
  "name": "Ada",
  "phone": null,
  "status": "SUBSCRIBED",
  "tags": [{ "id": "tag_abc", "name": "newsletter" }],
  "fields": {}
}

[email protected] · lumail.subscribers

subscribers.get(idOrEmail: string): Promise<LumailResult<GetSubscriberResponse>>

Id or email.

Path Parameters

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

Response Fields

Field	Type	Description
`id`	string	Subscriber id.
`email`	string	Email.
`name`	string or null	Display name.
`phone`	string or null	Phone.
`status`	`SubscriberStatus`	Current status.
`tags`	`{ id, name }[]`	Attached tags.
`fields`	`Record`	Custom fields.
`createdAt`	string	Optional ISO 8601 timestamp.
`updatedAt`	string	Optional ISO 8601 timestamp.

data is the subscriber. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.subscribers.create Nextlumail.subscribers.update