Scoresheet
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 a single scoresheet.
URI
/api/v9/scoresheets/IDGET Get a scoresheet
Return information about a scoresheet, identified by its ID.
Syntax
GET /api/v9/scoresheets/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/v9/scoresheets/123"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The scoresheet data was successfully returned |
404 Not Found | The scoresheet was not found |
Example response
Response
{
"created": "2023-07-01T10:00:00+00:00",
"scored": "2025-12-11T11:48:52+00:00",
"confirmed": null,
"name": "English proficiency (IELTS)",
"type": "IELTS",
"date": "Optional",
"depth": "Application",
"range_min": 4.5,
"range_max": 9.5,
"scale": 1,
"instructions": "Please provide your IELTS test results in the designated fields. If you have taken an alternative English proficiency test like TOEFL, you may skip specifying a IELTS score.",
"reference": "Required",
"subject": "None",
"language": "None"
}