v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB

Emails

List Emails Messages

This endpoint helps you to return a list of all emails previously sent. Query parameters are supported.

get/v2/emails

Query parameters

pageinteger

zero-based page index (0..N)

limitinteger

the size of the page to be returned

extidstring required

the external id to search

Response

Successfully retrieved the email messages

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "id": "203",
    "date": "2020-08-08T19:43:36.278949Z",
    "to": "test@service.com",
    "from": "from@service.com",
    "userName": "myAccount@delivery.com",
    "operator": "operatorAccount@delivery.com",
    "text": "content",
    "status": "SENT",
    "subject": "Greetings",
    "externalId": "123456789abcdef",
    "clientId": "48118112",
    "alias": "customer email alias (This field is optional)"
  }
}