Get the list of all the events for the received emails.

This endpoint will show the list of all the events for the received emails.

Authentication

api-keystring

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

Query parameters

senderstringOptional
Email address of the sender.
startDatestringOptionalformat: "datetime"

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

endDatestringOptionalformat: "datetime"

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

limitlongOptionalDefaults to 100
Number of documents returned per page
offsetlongOptionalDefaults to 0
Index of the first document on the page
sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation

Allowed values:

Response

List of events for received emails.
eventslist of objects or null

Errors