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/v9/applicants/ID/emails/ID

Get an email

Get information about an email that has been sent to the applicant.

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/v9/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/v9/applicants/123/emails/321"

Response headers

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

Response codes

Response code	Description
`200 OK`	The email data was successfully returned

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/v9/applicants/1/emails/123/attachments"
}

Emails

Attachments