Task
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single application task.
URI
/api/v9/applications/ID/tasks/IDGET Get a task
Fetch information about a specific application task identified by the task ID.
Also see Tasks for a more thorough explanation.
Syntax
GET /api/v9/applications/123/tasks/1
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/tasks/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The task data was returned |
404 Not Found | The task was not found |
Example response
Response
{
"id": 20,
"created": "2025-12-03T13:11:08+00:00",
"reminded": "2025-15-03T13:10:00+00:00",
"committed": null,
"resolved": null,
"class": "checklist-language-english",
"title": "Proof of English language proficiency",
"status": "I have NOT yet taken a language test",
"notes": {
"applicant": "I need help",
"administrator": null
}
}DELETE Delete a task
Remove the task identified by its ID from the application in question.
DreamApply handles task removal using the following rules:
- Scope: You can remove both active and trashed tasks using this request.
- Attached documents: Tasks can be removed even if they have documents attached. Deleting the task does not delete the documents; they remain linked to the application and stay accessible in the Documents section.
- Score re-calculation: When a task is deleted, DreamApply automatically re-calculates scores for all offers associated with the application. For details, see Offers.
Syntax
DELETE /api/v9/applications/123/tasks/1
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X DELETE \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applications/123/tasks/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The task was successfully deleted |
404 Not Found | The application does not have this task |