v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Emails

List sent emails

Retrieve a paginated list of sent emails. Results are ordered by send time, newest first.

Use filters to narrow down results by status, recipient, sender, or tag.

Related endpoints:

  • GET /emails/{emailId} - Get full details of a specific email
  • POST /emails - Send a new email
get/emails

Query parameters

status'pending' | 'sent' | 'softfail' | 'hardfail' | 'bounced' | 'held'

Filter by delivery status:

  • pending - Email accepted, waiting to be processed
  • sent - Email transmitted to recipient's mail server
  • softfail - Temporary delivery failure, will retry
  • hardfail - Permanent delivery failure
  • bounced - Email bounced back
  • held - Held for manual review
tostring email

Filter by recipient email address

fromstring email

Filter by sender email address

tagstring

Filter by tag

afterstring

Return emails sent after this timestamp (Unix seconds or ISO 8601)

beforestring

Return emails sent before this timestamp

pageinteger

Page number (starts at 1)

perPageinteger

Results per page (max 100)

Response

List of emails

pageinteger required

Current page number (1-indexed)

perPageinteger required

Items per page

totalinteger required

Total number of items

totalPagesinteger required

Total number of pages

Example response

{
  "data": [
    {
      "id": "aBc123XyZ456"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 150,
  "totalPages": 5,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}