Application

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

Represents a single application submitted by an applicant.

URI
/api/v10/applicants/ID/applications/ID

Get an application

Retrieve information about a specific application created or submitted by an applicant.

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

Parameters

Name	Required/Optional	Description	Notes
`expand`	Optional	One or more related entities to include in the response, for example, `applicant,flags`.	[1]

Notes

Note [1]: Some elements in the returned objects are links to other API requests. Using the expand parameter, you can expand this data to the actual records, saving additional API requests. The full list of possible expansions is applicant,flags,courses,offers,documents,tasks,scores,references,interviews. To request multiple expansions, combine them as a comma-separated list in the expand parameter.

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applicants/123/applications/321?expand=courses,interviews"

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 application data was successfully returned

Example response

Response
curl
{
  "visa": {
    "entry": {
      "date": "2028-02-03"
    }
  },
  "contact": {
    "address": {
      "street": "Maple street, 12345",
      "country": "GB",
      "postalcode": "123456",
      "municipality": "NY"
    },
    "emergency": {
      "name": "Jamie Smith",
      "telephone": "+123456890"
    },
    "telephone": {
      "mobile": "+1234568900"
    },
    "email": "j.smith@email.com"
  },
  "profile": {
    "name": {
      "given": "John",
      "family": "Smith"
    },
    "gender": "M",
    "citizenship": "US"
  },
  "id": 321,
  "created": "2026-04-22T12:10:21+00:00",
  "revised": "2026-05-18T13:04:28+00:00",
  "submitted": "2026-05-15T11:16:11+00:00",
  "status": "Submitted",
  "category": {
    "id": 2,
    "title": "International",
    "colour": "#00ff00",
    "mode": "Public"
  },
  "academic_term": "/api/v10/academic-terms/26",
  "applicant": "/api/v10/applicants/123",
  "flags": "/api/v10/applications/321/flags",
  "courses": {
    "16": {
      "priority": 1,
      "submitted": "2026-04-22T12:12:39+00:00",
      "deadline": "2026-06-01T23:59:59+00:00",
      "course": "/api/v10/courses/16",
      "intake": "/api/v10/intakes/9",
      "modifier": null
    },
    "20": {
      "priority": 2,
      "submitted": "2026-04-22T12:12:39+00:00",
      "deadline": null,
      "course": "/api/v10/courses/20",
      "intake": null,
      "modifier": null
    }
  },
  "offers": "/api/v10/applications/321/offers",
  "exports": "/api/v10/applications/321/exports",
  "documents": "/api/v10/applications/321/documents",
  "references": "/api/v10/applications/321/references",
  "scores": "/api/v10/applications/321/scores",
  "tasks": "/api/v10/applications/321/tasks",
  "pdf": "/api/v10/applications/321/pdf",
  "interviews": {
    "4": {
      "id": 4,
      "status": "completed",
      "scenario": {
        "id": 13,
        "title": "Interview to IT departments"
      },
      "invited": "2026-05-22T07:30:20+00:00",
      "started": "2026-05-22T07:34:09+00:00",
      "completed": "2026-05-22T07:34:34+00:00",
      "blocked": null,
      "evaluated": null,
      "details": [
        {
          "viewed": "2026-05-22T07:34:09+00:00",
          "completed": "2026-05-22T07:34:19+00:00",
          "attempts": 1
        },
        {
          "viewed": "2026-05-22T07:34:20+00:00",
          "completed": "2026-05-22T07:34:27+00:00",
          "attempts": 1
        },
        {
          "viewed": "2026-05-22T07:34:27+00:00",
          "completed": "2026-05-22T07:34:34+00:00",
          "attempts": 1
        }
      ],
      "responses": {
        "7": {
          "id": 7,
          "mime": "video/webm",
          "size": 189050,
          "duration": null,
          "uploaded": "2026-05-22T07:34:19+00:00",
          "transcoded": "2026-05-22T07:34:21+00:00",
          "question": "Please describe your greatest academic achievement.",
          "download": {
            "original": "/api/v10/interviews/4/responses/7/download",
            "webm": "/api/v10/interviews/4/responses/7/download/webm",
            "mp4": "/api/v10/interviews/4/responses/7/download/mp4"
          }
        },
        "8": {
          "id": 8,
          "mime": "video/webm",
          "size": 126196,
          "duration": null,
          "uploaded": "2026-05-22T07:34:27+00:00",
          "transcoded": "2026-05-22T07:34:29+00:00",
          "question": "Please describe your plans for the next 5 years.",
          "download": {
            "original": "/api/v10/interviews/4/responses/8/download",
            "webm": "/api/v10/interviews/4/responses/8/download/webm",
            "mp4": "/api/v10/interviews/4/responses/8/download/mp4"
          }
        },
        "9": {
          "id": 9,
          "mime": "video/webm",
          "size": 96164,
          "duration": null,
          "uploaded": "2026-05-22T07:34:34+00:00",
          "transcoded": "2026-05-22T07:34:36+00:00",
          "question": "Please talk about a hobby that you enjoy during your free time.",
          "download": {
            "original": "/api/v10/interviews/4/responses/9/download",
            "webm": "/api/v10/interviews/4/responses/9/download/webm",
            "mp4": "/api/v10/interviews/4/responses/9/download/mp4"
          }
        }
      }
    },
    "8": {
      "id": 8,
      "status": "invited",
      "scenario": {
        "id": 9,
        "title": "Interview for Humanities department"
      },
      "invited": "2026-06-23T12:06:41+00:00",
      "started": null,
      "completed": null,
      "blocked": null,
      "evaluated": null,
      "details": [],
      "responses": []
    }
  }
}

Applications

Consents