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 assigned to an applicant. For a tracker configured in DreamApply, see Tracker (global).
/api/v10/applicants/ID/trackers/IDGET Get a tracker
Retrieve information about a specific tracker assigned to an applicant.
This request does not return the tracker itself. It represents a relationship between an applicant and a tracker. Follow the tracker URI in the response to retrieve further information about the tracker.
GET /api/v10/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/v10/applicants/123/trackers/321"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 |
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/v10/applicants/trackers/321"
}PUT Set a tracker
Assign a tracker to an applicant.
This API request does not create a new tracker. It creates an association between the applicant and the tracker. The tracker to be assigned must already be configured in DreamApply.
To assign a tracker:
- Use
POST/api/v10/applicants/trackersto create a tracker first. - Use this request to assign the tracker to any number of applicants.
The request body must be left empty.
PUT /api/v10/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/v10/applicants/123/trackers/321"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The tracker was successfully assigned |
404 Not Found | The tracker was not found |
DELETE Delete a tracker
Remove a tracker from an applicant.
This API request does not delete the tracker itself. It only removes an association between the tracker and the applicant.
DELETE /api/v10/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/v10/applicants/123/trackers/321"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The tracker was successfully deleted |
404 Not Found | The tracker was not found |
404 Not Found | The applicant does not have this tracker |