lumail.emails.list

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

MethodGET
/api/v2/emails

[email protected] · lumail.emails

emails.list(params?: { limit?: number; after?: string; before?: string }): Promise<LumailResult<ListEmailsResponse>>

Newest first. Paginate with after or before email ids. Campaign sends and test emails are excluded.

Query Parameters

Pass after or before, not both. The cursor must be an email id in this organization.

NameTypeDescription
limitnumberPage size. Default 20. Min 1, max 100.
afterstringReturn emails older than this id (next page, walking backward in time).
beforestringReturn emails newer than this id.

Response Fields

FieldTypeDescription
object"list"Discriminator. Always list.
has_morebooleantrue when another page exists in the same direction.
dataEmailObject[]Email rows, newest first. Same fields as emails.get except object, html, text, and tags.

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