Tracker

Represents a single tracker assigned to an applicant. For a tracker configured in DreamApply, see Tracker (global).

URI
/api/v10/applicants/ID/trackers/ID

GET 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.

Syntax
GET /api/v10/applicants/123/trackers/321
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/v10/applicants/123/trackers/321"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonThe media type of the resource
Content-Length1234The size of the response body in bytes

Response codes

Response codeDescription
200 OKThe tracker is set to the applicant
404 Not FoundThe tracker was not found
404 Not FoundThe applicant does not have this tracker

Example response

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:

  1. Use POST /api/v10/applicants/trackers to create a tracker first.
  2. Use this request to assign the tracker to any number of applicants.

The request body must be left empty.

Syntax
PUT /api/v10/applicants/123/trackers/321
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applicants/123/trackers/321"

Response headers

HeaderValueDescription
Content-Typetext/plainThe media type of the resource
Content-Length0The size of the response body in bytes

Response codes

Response codeDescription
204 No ContentThe tracker was successfully assigned
404 Not FoundThe 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.

Syntax
DELETE /api/v10/applicants/123/trackers/321
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/v10/applicants/123/trackers/321"

Response headers

HeaderValueDescription
Content-Typetext/plainThe media type of the resource
Content-Length0The size of the response body in bytes

Response codes

Response codeDescription
204 No ContentThe tracker was successfully deleted
404 Not FoundThe tracker was not found
404 Not FoundThe applicant does not have this tracker