Applications

Represents a list of submitted applications.

/api/v9/applications

GET List applications

Retrieve a list of applications that match the set filtering criteria. As per norm, the HEAD verb is useful to just test if such an application exists (and how many).

GET /api/v9/applications
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Notes

• Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators — in other words an application is considered matching if it matches to any of the values in the list.
• Note [2]: This limits selection to applications that have been submitted, since offers (initially in “Unreplied” status) will be created while submitting an application. An application may contain any number of courses, but they will be turned into offers only at submission. This also applies to edits made after submission. For example an applicant may add a course after submission, but the corresponding offer will appear only after submission.
• Note [3]: Currently only one flag ID can be listed. This limitation will be lifted at a later date.
• Note [4]: Some elements in the returned objects are links to other API requests. Using the expand parameter, it is possible to 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. You can set one or multiple expansions, combining them in a comma-separated fashion to the expand parameter. Note also that using this parameter caps to limit to 8192 due to performance reasons.

Example request

curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications?byAcademicTermID=27&byCreatedSince=2025-10-01T00:00:00&byFlagIds=8"

Response headers

Response codes

Example response

{
  "123": {
    "id": 123,
    "created": "2025-10-07T07:09:15+00:00",
    "revised": "2025-10-08T12:20:17+00:00",
    "submitted": "2025-10-10T07:00:06+00:00",
    "status": "Reopened",
    "category": {
      "id": 2,
      "title": "International",
      "colour": "#00ff00",
      "mode": "Public"
    },
    "academic_term": "/api/v9/academic-terms/27",
    "applicant": "/api/v9/applicants/321",
    "flags": "/api/v9/applications/123/flags",
    "courses": "/api/v9/applications/123/courses",
    "offers": "/api/v9/applications/123/offers",
    "exports": "/api/v9/applications/123/exports",
    "documents": "/api/v9/applications/123/documents",
    "references": "/api/v9/applications/123/references",
    "scores": "/api/v9/applications/123/scores",
    "tasks": "/api/v9/applications/123/tasks",
    "pdf": "/api/v9/applications/123/pdf"
  },
  "124": {
    "id": 124,
    "created": "2025-10-27T08:22:40+00:00",
    "revised": "2025-11-25T12:00:50+00:00",
    "submitted": "2025-11-03T14:32:32+00:00",
    "status": "Submitted",
    "category": {
      "id": 2,
      "title": "International",
      "colour": "#00ff00",
      "mode": "Public"
    },
    "academic_term": "/api/v9/academic-terms/27",
    "applicant": "/api/v9/applicants/322",
    "flags": "/api/v9/applications/124/flags",
    "courses": "/api/v9/applications/124/courses",
    "offers": "/api/v9/applications/124/offers",
    "exports": "/api/v9/applications/124/exports",
    "documents": "/api/v9/applications/124/documents",
    "references": "/api/v9/applications/124/references",
    "scores": "/api/v9/applications/124/scores",
    "tasks": "/api/v9/applications/124/tasks",
    "pdf": "/api/v9/applications/124/pdf"
  }
}

POST Create an application

Create a new application with minimal initial data: applicant, intake and course.

Depending on the provided parameters, the request can result in two possible outcomes:

• Create a new application: If no application exists for the applicant and intake, a new standalone application is created
• Add a course to the application: If an application already exists for the applicant in the intake, the provided course is added to the application.

After creating an application, you can manage its content using the following requests:

• Update application data: PATCH /api/v9/applications/ID/
• Add courses to the application: POST /api/v9/applications/ID/courses
• Set course priority: PUT /api/v9/applications/ID/courses/ID/priority

Validation rules

The API validates the following conditions before processing the request:

• The applicant must have the citizenship set.
• The applicant must have the category set (if public categories are set up).
• The application limits must not be exceeded.
• An existing application must not be closed, withdrawn or expired.

The following limitations are not enforced during this request:

• Course-level restrictions (such as territory requirements)
• Intake limitations (such as category eligibility or territory-specific deadlines)
• Course status checks (for example, Online vs. Standby)

POST /api/v9/applications
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Example request

curl \
  -X POST \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications?applicant=123&intake=1&course=2"

Response headers

Response codes