This is an old revision of the document!
/api/applicants
HEAD, GET
List applicants using the filters set as parameters. The number of applicants is represented in the X-Count header - use the HEAD request to simply count the number of applicants matching the filters. Use the GET request to actually fetch them.
Syntax
GET /api/applicants Host: apply.example.edu Authorization: DREAM apikey="..."
Parameters
?byCitizenships | Optional | Comma or space-separated list of citizenships |
?byTrackerCodes | Optional | Comma or space-separated list of ISO 3166-1 alpha-2 country codes |
Response headers
Content-Type: application/json Content-Length: 1456 X-Count: 15