v93

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Email Sends

List sent emails

Lists the recent 14-day delivery history with dashboard-equivalent subject, recipient, status, type, bounce, source, pagination, and sorting filters. Test sends and copied-recipient bookkeeping rows are hidden unless the copy bounced or complained.

get/email-sends

Query parameters

searchstring

Case-insensitive subject/title or recipient search. q is accepted as an alias.

qstring

Compatibility alias for search.

subjectstring

Case-insensitive subject/title filter. title is accepted as an alias.

titlestring

Compatibility alias for subject.

recipientstring

Case-insensitive recipient email filter.

status'pending' | 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'failed' | 'suppressed'

Delivery status. Opened includes clicked deliveries.

emailType'campaign' | 'transactional' | 'sequence'
bounceType'Permanent' | 'Transient'
campaignIdstring
transactionalEmailIdstring
automationIdstring
daysinteger
pageinteger
limitinteger
sortField'recipientEmail' | 'subject' | 'status' | 'eventAt' | 'sentAt' | 'createdAt'
sortOrder'asc' | 'desc'

Response

Paginated sent-email history

successboolean
retentionDaysinteger

Example response

{
  "retentionDays": 14,
  "emailSends": [
    {
      "id": "send_123",
      "companyId": "company_123",
      "subject": "Welcome"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}