What's new in DreamApply API

Added the ability to specify the course ID for the issued invoice.

For details, see: POST /api/v9/applications/ID/invoices.

The Offers collection and Offer resource now include explanation fields that provide a detailed audit trail of the logic used to calculate the final score.

For details, see:

• GET /api/v9/applications/ID/offers
• GET /api/v9/applications/ID/offers/ID

Introduced the /api/purged-resources endpoint to get a list of entities — applications and applicants — that were deleted from the system.

For details, see GET /api/purged-resources.

Added the ability to filter courses by public course codes: byCodes=7991,7992.

For details, see GET /api/courses.

Added the ability to delete a specific task.

For details, see DELETE /api/applications/ID/tasks/ID.

Added the ability to update specific fields within an existing application. The following application sections can be updated:

• Profile
• Legal entity information
• Contacts
• Education
• Languages
• Career
• Activities
• Residences
• Custom sections

For details, see PATCH /api/applications/ID.

DreamApply has updated how dates are returned across the system to simplify parsing and align with modern integration standards.

Previously, some sections in responses represented dates as structured arrays with separate fields. Starting from version 9, dates are provided as a single, unified string.

Before:

"period": {
    "to": {
        "yy": "2025",
        "mm": "12"
    },
    "from": {
        "yy": "2025",
        "mm": "02"
    }
}

Version 9 and later:

"period": {
    "to": "2025-12",
    "from": "2025-02"
}

Affected sections (application):

• education [enrolment,graduation,suspension]
• activities [from,to]
• career [from,to]
• residences [from,to]

DreamApply now uses the ISO 8601 standard for date and time data in tableviews.

Datetime

Before:

"2025-08-05 12:13:02"

Version 9 and later:

"2025-08-05T12:13:02+00:00"

Date

Before:

"2025-08-05"

Version 9 and later:

"2025-08-05"

Tableviews now use ISO alpha-2 codes (two-letter identifiers) for country and language data.

Before:

"EE Estonia"

Version 9 and later:

"EE"

Data in extra fields and custom sections is now returned in a more explicit, structured format.

Previously, this data was returned as an array of nested objects. In version 9, each entry is represented as a dedicated object identified by a unique extra@id or section@id. This structure provides a more organized way to distinguish and access specific data points.

Before:

"education-extras": [
    {
        "value": "Some info",
        "type": "Text",
        "name": "Text",
        "id": 1
    },
    {
        "value": "2024-03-01",
        "type": "Date",
        "name": "Date",
        "id": 2
    },
    {
        "value": "+37256789876",
        "type": "Phone",
        "name": "Phone number",
        "id": 3
    }
]

Version 9 and later:

"education-extras": {
    "extra@1": {
        "value": "Some info",
        "type": "Text",
        "name": "Text field",
        "id": 1
        },
    "extra@2": {
        "value": "2024-03-01",
        "type": "Date",
        "name": "Date",
        "id": 2
    },
    "extra@3": {
        "value": "+37256789876",
        "type": "Phone",
        "name": "Phone number",
        "id": 3
    }
}

Added the ability to retrieve documents attached to a specific task (ZIP archive).

The skip-extracted-pages parameter allows retrieving only the original PDF files and skip JPEG previews generated by DreamApply.

For details, see GET /api/applications/ID/tasks/ID/documents/zip.

Added the ability to retrieve a list of references or a specific reference submitted for the application.

The expand parameter of the applications collection and the application resource now supports the references value.

For details, see:

• GET /api/applications/ID/references
• GET /api/applications/ID/references/ID
• GET api/applications
• GET api/applications/ID

Added the ability to create an application with minimal initial data for the applications collection and the applicant resource.

For details, see:

• POST api/applications
• POST /api/applicants/ID/applications

• Added the ability to add a course (priority) to an application. For details, see
  POST /api/applications/ID/courses.
• Added the ability to remove a course (priority) from an application. For details, see DELETE /api/applications/ID/courses/ID.
• Added the ability to retrieve the priority level of a course in an application. For details, see GET /api/applications/ID/courses/ID/priority.
• Added the ability to set the priority level for a course in an application. For details, see PUT /api/applications/ID/courses/ID/priority.

API version 3 is deprecated starting January 2026 and will be sunset in August 2026. This version will no longer receive updates or bug fixes, but requests will continue to be supported until sunsetting.

For details, see GET api/versions and Supported API versions