Tracker
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 tracker set on an applicant. For a tracker created in the system, see Tracker (global).
/api/v9/applicants/ID/trackers/IDGET Get a tracker
Get information about a specific tracker set on an applicant.
This request does not return the tracker itself, but rather represents the relationships between the applicant and the tracker. Follow the tracker URI in the response to retrieve further information about the tracker in question.
GET /api/v9/applicants/123/trackers/321
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applicants/123/trackers/321"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 tracker is set to the applicant |
404 Not Found | The tracker was not found |
404 Not Found | The applicant does not have this tracker |
Example response
{
"assigned": "2025-10-03T13:00:42+00:00",
"tracker": "/api/v9/applicants/trackers/321"
}PUT Set a tracker
Set a tracker to the applicant in question. This requires that the tracker already exists. Use POST /api/v9/applicants/trackers to create a tracker first, then this API request will allow you to set the tracker (identified by its code) to any number of applicants.
In other words, this will not create a new tracker, but create a relationship (association) between an existing tracker and an applicant.
The body of the request is left empty.
PUT /api/v9/applicants/123/trackers/321
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applicants/123/trackers/321"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 tracker was successfully set |
404 Not Found | The tracker was not found |
DELETE Delete a tracker
Remove the tracker from the applicant in question.
This request does not delete the tracker itself, only removing its association with the applicant in question.
DELETE /api/v9/applicants/123/trackers/321
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X DELETE \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applicants/123/trackers/321"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 | Tracker was successfully deleted |
404 Not Found | The tracker was not found |
404 Not Found | The applicant does not have this tracker |