Table of Contents

/api/applicants/ID

HEAD, GET

Return information about an applicant, identified by the applicant's ID.

Syntax

GET /api/applicants/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1234

Response example

{
      "registered": "2014-06-20T08:13:41+00:00",
      "name": {
          "given": "Joe",
          "middle": "",
          "family": "Smith"
      },
      "email": "sample.applicant.21@example.com",
      "skype": null,
      "phone": "+372 123456789",
      "reference": "foobar",
      "citizenship": "US",
      "trackers": "/api/applicants/123/trackers",
      "photo": "/api/applicants/123/photo",
      "documents": "/api/applicants/123/documents"
}