Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Transactional emails

Get the list of transactional emails on the basis of allowed filters

This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

get/smtp/emails

Query parameters

emailstring

Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.

templateIdinteger

Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.

messageIdstring

Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.

startDatestring

Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.

endDatestring

Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

limitinteger

Number of documents returned per page

offsetinteger

Index of the first document in the page

Response

List of transactional emails

countinteger

Total number of transactional emails available on your account according to the passed filter

Example response

{
  "count": 5,
  "transactionalEmails": [
    {
      "email": "john.smith@example.com",
      "subject": "Summer Camp",
      "templateId": 2,
      "messageId": "<201798300811.5700093@relay.domain.com>",
      "uuid": "5a78c-209ok98262910-s99a341",
      "date": "2017-03-12T12:30:00Z",
      "from": "diana.doe@example.com",
      "tags": [
        "tag1"
      ]
    }
  ]
}