Get a tracking email

Get an tracking email by id.

get

Path parameters

idstringRequired

The id of the tracking email.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/tracking-emails/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "countryCode": "US",
    "languageCode": "en",
    "notificationType": "System",
    "notificationChannelType": "Email",
    "emailFrom": "[email protected]",
    "emailTo": "[email protected]",
    "emailCc": "[email protected]",
    "emailBcc": "[email protected]",
    "emailSubject": "Welcome to JFW!",
    "emailBody": "Welcome to JFW API!",
    "sentTime": "2025-07-15T07:34:48.6056656Z",
    "testMode": false,
    "tags": "Welcome, JFW",
    "status": "ReadEmailNotification"
  },
  "errors": []
}