Emails

List recent sent emails

get/emails

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/emails
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of emails to return (1–100)

cursorstring

Opaque cursor for the next page

testboolean

true lists only test emails (test keys and simulator addresses), false only live ones. Omit for both.

tenantstring

Only this tenant's emails (its external_id or id). A key limited to one tenant always sees only its tenant's.

stream'transactional' | 'product' | 'newsletter'

The mail stream an email went out on, from its category. Each stream sends from its own IPs. newsletter is for approved accounts only.

Only emails sent on this mail stream (transactional, product or newsletter).

Response

Email list

has_moreboolean required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.