List emails
Search the project's emails by status, recipient, sender, subject, tag and date.
/v1/emailsAPI keyReturns the project's emails, newest first, paginated. Every filter is optional and they combine with AND.
Each email includes its recipients, but events is always an empty array here. Retrieve the email to get its event timeline.
Query parameters
1 to 100.
The nextCursor from the previous page.
One of queued, scheduled, sending, sent, delivered, deferred, bounced, complained, rejected, failed, test, canceled. See Email statuses.
Matches any recipient, whether in to, cc or bcc. A full address (with @) must match exactly. Anything else matches part of an address, so to=example.com finds every recipient at that domain.
The sender's bare address, exact match. Case doesn't matter.
Text the subject contains.
One tag as key:value, for example tag=kind:welcome.
Only emails created at or after this ISO 8601 date-time. Needs a time zone offset.
Only emails created before this ISO 8601 date-time. Needs a time zone offset.
Response
The emails on this page. Each has the fields described in Retrieve an email, with events: [].
Pass it as cursor to get the next page. null on the last page.
Errors
| Status | Code | When |
|---|---|---|
| 400 | invalid_query | A parameter is invalid: limit out of range, an unknown status, a tag without :, or a date without a time zone. param names it. |