/email/messages

Changed on

Use this endpoint to retrieve all emails that are available in the current context.

The only valid orderby property is: dateModified.

This endpoint responds with an array of standard Email objects.

get/email/messages

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/email/messages
  • Auth
    HTTP basic

Query parameters

$orderbystring

Optional; sorts results in ascending (asc) or descending (desc) order by a comma-delimited list of properties: dateModified. Note that a space is required between the property and asc or desc.

Response

200

nextPageLinkunknown
countinteger

Example response

{
  "items": [
    {
      "foreignMessageId": "K3Jy8GbLEeuYiQAVXUPJkg2",
      "name": "Tom Nook Email",
      "createdBy": "Max Kamin-Cross",
      "dateCreated": "2021-02-04T04:27:00Z",
      "dateScheduled": "2021-02-04T04:29:00Z",
      "campaignID": 725,
      "dateModified": "2021-02-04T04:29:21.653Z"
    }
  ],
  "count": 2
}

Changes