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.
| Name | Type | Description |
|---|---|---|
limit | number | Page size. Default 20. Min 1, max 100. |
after | string | Return emails older than this id (next page, walking backward in time). |
before | string | Return emails newer than this id. |
Response Fields
| Field | Type | Description |
|---|---|---|
object | "list" | Discriminator. Always list. |
has_more | boolean | true when another page exists in the same direction. |
data | EmailObject[] | 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 } }.