Get tracking emails

PreviousGet a tracking email NextUsers

Last updated 2 months ago

Was this helpful?

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

The status of the tracking email.

Possible values:

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

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

PageSizeinteger · int32Optional

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

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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

Example: YOUR_BRAND_URL

AuthkeystringRequired

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 AuthKey header.

application/json

429

The user has exceeded the rate limit.

application/json

get

GET /api/tracking-emails HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "countryCode": "US",
        "languageCode": "en",
        "notificationType": "System",
        "notificationChannelType": "Email",
        "emailFrom": "no-reply@example.com",
        "emailTo": "user@example.com",
        "emailCc": "cc@example.com",
        "emailBcc": "bcc@example.com",
        "emailSubject": "Welcome to JFW!",
        "emailBody": "Welcome to JFW API!",
        "sentTime": "2025-05-08T13:15:32.100722Z",
        "testMode": false,
        "tags": "Welcome, JFW",
        "status": "ReadEmailNotification",
        "id": "sApKpllz4sAplsmzha"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}