Tracker (global)
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 code configured in the system. For a specific tracker code assigned to a specific applicant, see Tracker.
URI
/api/v9/applicants/trackers/IDGET Get a tracker
Get information about a specific tracker code currently available in the system.
Syntax
GET /api/v9/applicants/trackers/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/applicants/trackers/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1456 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The tracker exists |
404 Not Found | The tracker was not found |
Example response
Response
{
"id": 37,
"created": "2025-07-29T12:53:20+00:00",
"code": "DISCOUNT10",
"notes": "Some notes",
"reduction": {
"reduction": "Percent",
"percent": 10
}
}DELETE Delete a tracker
Remove the tracker code from the system, also removing it from all applicants.
Syntax
DELETE /api/v9/applicants/trackers/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/applicants/trackers/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 tracker was successfully deleted |
404 Not Found | The tracker was not found |