Email

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a single email sent to an applicant.

URI
/api/v10/applicants/ID/emails/ID

Get an email

Retrieve information about a specific email sent to an applicant.

You can see when the email was delivered and when it was opened (although the times may not be accurate). If the email is still being delivered, the corresponding timestamp contains null.

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

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applicants/123/emails/321"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1234`	The size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The email data was successfully returned
`404 Not Found`	The email was not found

Example response

Response
{
  "inserted": "2025-06-29T18:11:15+00:00",
  "delivered": "2025-06-29T18:11:15+00:00",
  "failed": null,
  "opened": "2025-06-30T10:15:49+00:00",
  "from": {
    "email": "sender@uni.edu",
    "name": "Admission Office"
  },
  "subject": "Hello world!",
  "message": "Hi there!",
  "attachments": "/api/v10/applicants/1/emails/123/attachments"
}