Applicant
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 an applicant or lead registered in DreamApply.
URI
/api/v10/applicants/IDGET Get an applicant
Retrieve information about a specific applicant or lead.
Syntax
GET /api/v10/applicants/123
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"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The applicant information was successfully returned |
404 Not Found | The applicant was not found |
Example response
Response
{
"id": 123,
"type": "Child",
"registered": "2025-10-15T10:33:16+00:00",
"name": {
"full": "Emily Williams",
"given": "Emily",
"middle": null,
"family": "Williams",
"parent": "Jane Williams"
},
"email": "e.williams@email.com",
"phone": "+1234567890",
"reference": "1234567",
"matriculation": "ABC123",
"citizenship": "GB",
"notes": "Strong candidate",
"applications": "/api/v10/applicants/123/applications",
"trackers": "/api/v10/applicants/123/trackers",
"photo": "/api/v10/applicants/123/photo",
"consents": "/api/v10/applicants/123/consents",
"invoices": "/api/v10/applicants/123/invoices",
"wishes": "/api/v10/applicants/123/wishes"
}