Trackers

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of tracker associations for the applicant in question. For a list of trackers created in the system, see Trackers (global).

URI
/api/v9/applicants/ID/trackers

List trackers

Get a list of tracker associations for the applicant in question.

This request does not return the trackers themselves, but rather represents the relationships between an applicant and trackers. Follow the tracker URI in the response to retrieve further information about the tracker in question.

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

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`2`	Number of returned trackers

Response codes

Response code	Description
`200 OK`	The list of tracker codes assigned to the applicant was successfully returned

Example response

Response
{
  "1": {
    "assigned": "2025-10-03T13:00:42+00:00",
    "tracker": "/api/v9/applicants/trackers/123"
  },
  "2": {
    "assigned": "2025-10-03T13:00:42+00:00",
    "tracker": "/api/v9/applicants/trackers/321"
  }
}

Emails

Tracker