Tasks
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 list of tasks created for an application.
/api/v10/applications/ID/tasksGET List tasks
List all tasks generated for an application.
The Business Rules Engine in DreamApply automatically creates tasks for applications depending on the rules set up for each client. Task titles, descriptions (for example, instructions) and available task statuses can be fully customized.
Example request
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applications/123/tasks"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 |
X-Count | 4 | The number of tasks created for this application |
Response fields
The ID of a task created for the application.
The date and time when the task was initially created.
The date and time when the applicant was last reminded of the task. The field contains null if no reminders have been sent yet.
The date and time when the task was last saved by the applicant or an Administrator. The field contains null if the task was not modified by anybody and remains in its initial state.
The date and time when the task was finally resolved. The field contains null if the task is still not resolved, and a sufficiently advanced status has not been assigned yet.
The date and time when the task was closed (the task status closing the task was set).
The date and time when the task was sent to trash. The field contains null if the task is active or was restored from the trash.
The type of the task, or the template from which the task was created.
The status currently assigned to the task.
This value is the status name and must be a reliable identifier. In some cases, the title (as opposed to the name) of the status that is actually displayed may be different. The name of the status must be as concise as possible. The title may be much more verbose, along with an even more verbose description. You may think of the name as a ‘slug’.
Notes added to the task.
Notes added by the applicant.
Notes added by an Administrator.
Notes added to the task.
Notes added by the applicant.
Notes added by an Administrator.
Notes added to the task.
Notes added by the applicant.
Notes added by an Administrator.
Response codes
| Response code | Description |
|---|---|
200 OK | The list of tasks was successfully returned |
Example response
{
"20": {
"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
}
},
"21": {
"id": 21,
"created": "2025-12-03T13:11:08+00:00",
"reminded": "2025-15-03T13:10:00+00:00",
"committed": null,
"resolved": null,
"class": "checklist-entry-se",
"title": "Entry qualification documents",
"status": "I have finished high school / secondary school. I am preparing the documents for submission (final diploma and academic records)",
"notes": {
"applicant": null,
"administrator": "Looks good!"
}
}
}POST Assign a task
Create a new task for an application. If required in the task template (class), DreamApply also sends a notice/reminder to an applicant.
POST /api/v10/applications/123/tasks
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description |
|---|---|---|
taskClassID | Required | The ID of the task template (class) to use |
Example request
curl \
-X POST \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applications/123/tasks?taskClassID=15"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Location | /api/applications/123/tasks/321 | The URI of the assigned task |
Response codes
| Response code | Description |
|---|---|
201 Created | A new task was created, see also the returned Location header |
409 Conflict | A task form this template (class) already exists in this application |