Get the list of transactional emails on the basis of allowed filters
GET {{baseUrl}}/smtp/emails?email=veniam elit in&templateId=13396752&messageId=veniam elit in&startDate=veniam elit in&endDate=veniam elit in&sort=desc&limit=500&offset=0
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
email | string | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | |
templateId | number | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | |
messageId | string | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | |
startDate | string | 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. | |
endDate | string | 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 | string | Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed | |
limit | number | Number of documents returned per page | |
offset | number | Index of the first document in the page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":120,"transactionalEmails":[{"email":"abc@xyz.com","subject":"summer camp","templateId":15,"messageId":"\u003c201798300811.5787683@relay.domain.com\u003e","uuid":"5a78c-209ok98262910-std2341","date":"2019-05-25T11:53:26.000Z"},{"email":"test@test.com","subject":"details verification","templateId":15,"messageId":"\u003c201798300811.5700093@relay.domain.com\u003e","uuid":"5a78c-209ok98262910-s99a341","date":"2019-05-25T07:28:11.000Z"}]}