Guide·For admins
Public catalogue and online applications
On the Institution plan you can publish your programmes on your own subdomain and accept applications, either through a ready-made form or from your own website.
- 1
Turn on your admissions settings
Open Settings → Admissions. Switch on the public catalogue, choose what happens once a class is full, optionally set how many days before a year starts applications close, and decide whether teachers may review applications.
- 2
Mark programmes as public
Open a programme → Settings tab and switch on List in public catalogue for every programme you want prospective students to see. Keep each year open for intake, and set a start date if you use the early-close window.
- 3
Read your catalogue from your own website
Your developer can call GET /api/catalogue?subdomain=your-school to list your public programmes and the academic years that are open. Inactive years, years that have already ended, and years past the early-close window are left out. No key is needed while the catalogue is switched on.
- 4
Create an admissions key
In Settings → Admissions, create an admissions key. The secret is shown only once, so store it on your own server and never in a web page.
- 5
Send applications from your own website
POST /api/admissions/applications with Authorization: Bearer ak_… and the same fields as the ready-made application form. Your institution is identified by the key itself, so never send an institution reference from the browser. Years that are closed reply with VERSION_NOT_OPEN (403).