GET /smtp/emails

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.

Servers

Query parameters

Name Type Required Description
endDate String No

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.

email String No

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

templateId String No

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

limit String No

Number of documents returned per page

sort String No

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

startDate String No

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.

messageId String No

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

offset String No

Index of the first document in the page

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.