Application on DreamApply Knowledge Base

Application freezing

Mon, 01 Jan 0001 00:00:00 +0000

Represents a resource that allows freezing an application.

URI

/api/v9/applications/ID/freeze

Freeze an application

Freeze the application data to prevent further changes by the applicant.

When an application is frozen, the existing scores on the scoresheets to which the application is added are also frozen and cannot be edited by an applicant. Administrators can still update the application data and scores through the administrative portal.

Application defrosting

Mon, 01 Jan 0001 00:00:00 +0000

Represents a resource that allows defrosting an application.

URI

/api/v9/applications/ID/unfreeze

Unfreeze an application

Unfreeze the application data to allow further changes by the applicant.

When an application is defrosted, the existing scores on the scoresheets to which the application is added are also defrosted and can be edited by the applicant.

To record the action, DreamApply creates the Application was defrosted journal event.

Syntax

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

Example request

Request

 curl
 
 
curl \
 -X POST \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/unfreeze"

Response codes

Response code	Description
`201 Created`	The application was successfully defrosted
`404 Not Found`	The application was not found

Application closing

Mon, 01 Jan 0001 00:00:00 +0000

Represents a resource that allows closing an application

URI

/api/v9/applications/ID/close

Close an application

Close an application.

Closing an application formally finalizes the application status. It indicates that no further actions will be taken on the application, regardless of the admission decision.

To record the action, DreamApply creates the Application was closed journal event.

Syntax

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

Example request

Request

 curl
 
 
curl \
 -X POST \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/close"

Response codes

Response code	Description
`201 Created`	The application was successfully closed
`400 Bad Request`	This application cannot be closed, for example, if a request is sent to an already closed application
`404 Not Found`	The application was not found

Scores

Mon, 01 Jan 0001 00:00:00 +0000

Represents a list of scores for the application.

URI

/api/v9/applications/ID/scores

List scores

Return a list of scores for the application.

Syntax

GET /api/v9/applications/123/scores
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/scores"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`2`	Number of scores for this application

Response codes

Response code	Description
`200 OK`	The list of scores was successfully returned

Example response

Response

 
 
 
{
 "20": {
 "scored": "2025-12-11T11:49:45+00:00",
 "scoresheet": "/api/v9/scoresheets/1",
 "application": "/api/v9/applications/415",
 "offer": null,
 "points": "9.50",
 "comments": "Strong candidate",
 "date": null,
 "reference": null,
 "subject": null,
 "language": null
 },
 "21": {
 "scored": "2025-12-11T11:48:52+00:00",
 "scoresheet": "/api/v9/scoresheets/9",
 "application": "/api/v9/applications/415",
 "offer": null,
 "points": "1450",
 "comments": "SAT Score breakdown: EBRW 720 / Math 730",
 "date": "2025-03-09",
 "reference": "SAT-2025-5620",
 "subject": "SAT (Scholastic Assessment Test)",
 "language": "EN"
 }
}

PDF

Mon, 01 Jan 0001 00:00:00 +0000

Represents a PDF printout of the application.

URI

/api/v9/applications/ID/pdf

Generate a PDF printout

Retrieve a PDF printout of the application, replicating the Save as PDF feature in the user interface.

The PDF conversion is happening in real time and may take a few seconds to process on larger applications. The API request is also subject to modest throttling, so you may need to slow down your requests when fetching a large number of PDFs.

Application on DreamApply Knowledge Base

Application freezing

POST Freeze an application

Application defrosting

POST Unfreeze an application

Example request

Response codes

Application closing

POST Close an application

Example request

Response codes

Scores

GET List scores

Example request

Response headers

Response codes

Example response

PDF

GET Generate a PDF printout

Freeze an application

Unfreeze an application

Close an application

List scores

Generate a PDF printout