Intakes

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of configured intakes.

URI
/api/v9/intakes

API request	Return Type	Verb	Description
`/api/v9/intakes`	C	,	List configured intakes
`/api/v9/intakes/ID/`	R	,	Get more detailed information about a specific intake

List intakes

List all intakes that have been configured in the system. Knowing the intake IDs may be useful for filtering applications.

A course can be offered under several intakes (Winter, Autumn etc.) with each intake governing the application period, deadlines and other policies.

All dates (for example deadlines) are configured using ISO date notation, but skipping the year part as the intake system is designed to automatically roll over to the next year when appropriate. For this reason, dates are normally specified as 0000-MM-DD, for example 0000-04-23.

Syntax
GET /api/v9/intakes
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/intakes"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`3`	Number of configured intakes

Response codes

Response code	Description
`200 OK`	The list of intakes was successfully returned

Example response

Response
{
  "1": {
    "id": 1,
    "name": "Fall semester intake",
    "start": "2025-01-01",
    "pre": {
      "deadline": null,
      "info": "Submit your application by the pre-deadline on July 01, 2025 for priority review, increased consideration and potential early access to scholarships.",
      "mask": false
    },
    "policy": "Strict (course)",
    "deadlines": {
      "001": {
        "deadline": "2025-06-01",
        "info": null
      }
    },
    "decision": {
      "policy": "Required",
      "days": 7
    },
    "arrival": "2025-08-31",
    "commence": "2025-08-01",
    "academic-term": {
      "id": 1,
      "year": "/api/v9/academic-years/2025",
      "name": "Fall semester 2025/26",
      "type": "/api/v9/academic-terms/types/1",
      "start": "2025-09-01",
      "grace": "2025-12-31",
      "finish": "2025-12-31"
    }
  },
  "2": {
    "id": 2,
    "name": "Spring semester intake",
    "start": "2025-07-01",
    "pre": {
      "deadline": "2026-02-01",
      "info": "Submit your application by the pre-deadline on February 01, 2026 for priority review, increased consideration and potential early access to scholarships.",
      "mask": true
    },
    "policy": "Strict (submit, hard)",
    "deadlines": {
      "001": {
        "deadline": "2026-02-28",
        "info": null
      }
    },
    "decision": {
      "policy": "Required",
      "days": 7
    },
    "arrival": "2026-03-01",
    "commence": "2026-03-15",
    "academic-term": {
      "id": 2,
      "year": "/api/v9/academic-years/2025",
      "name": "Spring semester 2025/26",
      "type": "/api/v9/academic-terms/types/2",
      "start": "2026-01-01",
      "grace": "2026-01-10",
      "finish": "2026-05-31"
    }
  }
}

Courses

Intake