Get the list of all the events for the received emails.
GET {{baseUrl}}/inbound/events?sender=veniam elit in&startDate=1947-08-13&endDate=1947-08-13&limit=100&offset=0&sort=desc
This endpoint will show the list of all the events for the received emails.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sender | string | Email address of the sender. | |
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. | |
limit | number | Number of documents returned per page | |
offset | number | Index of the first document on the page | |
sort | string | Sort the results in the ascending/descending order of record creation |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"events":[{"uuid":"1a825d56-029b-4a41-b8e4-1a825d56","date":"2017-03-11T12:30:00.000Z","sender":"john@example.com","recipient":"alexa@example.com"},{"uuid":"1a825d56-029b-4a41-b8e4-61670463431b","date":"2017-03-12T12:30:00.000Z","sender":"alice@example.com","recipient":"bob@example.com"}]}