FlaresendDocs
Admin API

List emails across projects

Search the email log of every project, or one project by slug.

GET/v1/admin/emailsAdmin key

The admin version of List emails. It takes the same filters and returns the same shape, but covers every project unless you pass project. Newest first. Each email includes its recipients but not its event timeline (events is []); fetch one email with GET /v1/admin/emails/:id for the timeline.

Query parameters

projectstringquery

Only emails from the project with this slug.

limitintegerquerydefault: 25

Page size, 1 to 100.

cursorstringquery

The nextCursor from the previous page.

statusstringquery

One email status: queued, scheduled, sending, sent, delivered, deferred, bounced, complained, rejected, failed, test or canceled.

tostringquery

Matches any recipient (to, cc or bcc). A full address matches exactly; text without @ matches part of an address, for example example.com.

fromstringquery

The sender address, exact match (not the display name).

qstringquery

Text the subject contains.

tagstringquery

A tag as key:value, for example kind:welcome.

sincestringquery

Only emails created at or after this ISO 8601 date-time (with offset).

untilstringquery

Only emails created before this ISO 8601 date-time (with offset).

Response

dataEmail[]

The emails, with the fields described in Retrieve an email.

nextCursorstring | null

Pass it as cursor for the next page. null on the last page. See Pagination.

Errors

StatusCodeWhen
400invalid_queryA filter is malformed, for example tag without a colon or limit over 100.
404project_not_foundproject is set and no project has that slug.