Academic years
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 list of all academic years.
URI
/api/v10/academic-yearsView all API request
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v10/academic-years | C | GET HEAD | List all academic years configured in DreamApply |
/api/v10/academic-years/year | R | GET HEAD | Get an academic year configured in DreamApply |
GET List academic years
List all academic years configured in DreamApply.
An academic year does not have to align with the calendar year. It may also have a name like 2017/18 when it spans, for example, from September to September.
Syntax
GET /api/v10/academic-years
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/academic-years"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 |
X-Count | 4 | The number of configured academic years |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of years was successfully returned |
Example response
Response
{
"2023": {
"name": "2023/24",
"start": "2023-09-01"
},
"2024": {
"name": "2024/25",
"start": "2024-09-01"
},
"2025": {
"name": "2025/26",
"start": "2025-09-01"
},
"2026": {
"name": "2026/27",
"start": "2026-09-01"
}
}