Get tracking emails

Get the list of tracking emails.

get

Query parameters

UserIdstringOptional

The id of the user.

EventIdstringOptional

The id of the event.

CountryCodestringOptional

The country code. This is a two letter country code.

LanguageCodestringOptional

The language code. This is a two letter language code.

Typestring · enumOptional

The notification type.

Possible values:

NotificationChannelTypestring · enumOptional

The notification channel type.

Possible values:

EmailFromstringOptional

The email from.

EmailTostringOptional

The email to.

EmailCcstringOptional

The email cc.

EmailBccstringOptional

The email bcc.

EmailSubjectstringOptional

The email subject.

EmailBodystringOptional

The email body.

TestModebooleanOptional

Flag to indicate if the email is in test mode.

KeywordsstringOptional

Filter by keywords.

TagsstringOptional

The tags.

Statusstring · enumOptional

Contains the enums for the status of notifications/emails with the user.

Possible values:

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

401

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

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/tracking-emails

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "countryCode": "US",
        "languageCode": "en",
        "notificationType": "Broadcast",
        "notificationChannelType": "Email",
        "emailFrom": "[e-mail]",
        "emailTo": "[e-mail]",
        "emailReplyTo": "[e-mail]",
        "emailCc": "[e-mail]",
        "emailBcc": "[e-mail]",
        "emailSubject": "Welcome to JFW!",
        "emailBody": "Welcome to JFW API!",
        "sentTime": "2026-01-26T01:03:23.906554Z",
        "testMode": false,
        "tags": "Welcome, JFW",
        "status": "ReadEmailNotification"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}