Email APITransactional email

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.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

emailstringOptional

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

templateIdlongOptional

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

messageIdstringOptional

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

startDatestringOptional

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.

endDatestringOptional

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.

sortenumOptionalDefaults to desc

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

Allowed values:
limitlongOptionalDefaults to 500
Number of documents returned per page
offsetlongOptionalDefaults to 0
Index of the first document in the page

Response

List of transactional emails
countlong or null
Total number of transactional emails available on your account according to the passed filter
transactionalEmailslist of objects or null

Errors