Reference

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

Represents a single reference submitted for the application.

URI
/api/v9/applications/ID/references/ID

GET Get a reference

Retrieve information about a particular reference submitted for the application.

Syntax
GET /api/v9/applications/123/references/321
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/applications/123/references/321"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonMedia type of the resource
Content-Length1234Size of the response body in bytes

Response codes

Response codeDescription
200 OKThe reference was successfully returned
404 Not FoundThe reference was not found

Example response

Response
{
  "id": 1,
  "invited": "2026-02-17T11:15:03+00:00",
  "accessed": "2026-02-17T11:19:05+00:00",
  "committed": "2026-02-17T11:19:18+00:00",
  "invitation": {
    "name": "Sarah Tyler",
    "email": "sarah.tyler@email.com"
  },
  "data": {
    "referee": {
      "name": "Linda Jason"
    },
    "evaluation": {
      "essay": "It is a pleasure to recommend Linda Jason, a candidate who stands out through her sharp analytical mindset and exceptional interpersonal maturity.\n\nAcademic and Professional Excellence\nLinda possesses a remarkable ability to transform complex data into actionable strategies. During her tenure, she spearheaded a cross-departmental project that improved efficiency by 20%, demonstrating a \"first-principles\" approach to problem-solving. She doesn't just execute tasks; she optimizes them, consistently delivering high-quality results under tight deadlines.\n\nPersonal Characteristics\nWhat truly differentiates Linda is her emotional intelligence and leadership style. She is a natural \"bridge-builder\" who maintains a calm, grounded demeanor even in high-pressure environments. Linda balances a high standard of accountability with genuine empathy, making her a vital asset to any collaborative team. Her intellectual humility and eagerness to grow ensure she will be a standout contributor to your program."
    }
  }
}

Previous

References