Sign in

v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Transactional

List transactional emails

Lists transactional email templates with their linked subjects and all-time delivery metrics. Search name, slug, or subject; filter active state; and sort by engagement. Human engagement is used by default.

get/transactional

Query parameters

searchstring

Case-insensitive search across template name, API slug, and linked email subject/title.

status'all' | 'active' | 'disabled'

Filter by template active state.

sort'date' | 'sends' | 'opens' | 'open-rate' | 'clicks' | 'ctr'

Sort by creation date or all-time engagement metrics.

order'asc' | 'desc'

Sort direction.

includeMachineEngagementboolean

Include detected bot, scanner, preview, and privacy-proxy engagement in open and click metrics.

Response

Successful response

successboolean

Example response

{
  "success": true,
  "transactional": [
    {
      "id": "tx_abc123",
      "name": "Welcome Email",
      "slug": "welcome-email",
      "emailId": "email_123",
      "enabled": true
    }
  ]
}