meta data for this page
  •  

This is an old revision of the document!


/api/applicants/ID/emails

HEAD, GET

Get a list of emails that have been sent to this applicant. Note that this list will only shows emails that have been stored. Any emails containing credentials or other secrets (for example password reminders) are delivered immediately without storing them to the database, an are therefore unavailable here as well.

Note that you can also see when the email was delivered and when it was opened (this may not be accurate). If the email is still being delivered, the timestamp contains a NULL.

Syntax

GET /api/applicants/123/emails
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1456

Example response

{
  "123": {
      "inserted": "2014-06-29T18:11:15+00:00",
      "delivered": "2014-06-29T18:11:15+00:00",
      "failed": NULL,
      "opened": "2014-06-30T10:15:49+00:00",
      "from": {
          "email": "[email protected]",
          "name": "Admission Office"
      },
      "subject": "Hello world!",
      "message": "Hi there!",
      "attachments": "/api/applicants/1/emails/123/attachments"
  },
  "321": {
      "inserted": "2014-07-10T19:21:55+00:00",
      "delivered": NULL,
      "failed": NULL,
      "opened": NULL,
      "from": {
          "email": "[email protected]",
          "name": "Admission Office"
      },
      "subject": "Hello world!",
      "message": "Hi there!",
      "attachments": NULL
  }
}