Intake

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

Represents a single intake configured in the system.

URI
/api/v9/intakes/ID

Get an intake

Get the details of the intake in question.

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/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/intakes/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 intake data was successfully returned
`404 Not Found`	The intake was not found

Example response

Response
{
  "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"
  }
}

Intakes

Invoices