Before writing code, confirm that your Lernmark account and programme catalogue are ready for public use.
What you need
- An active Lernmark subscription with the Admissions capability enabled.
- An institution approved for public listing.
- Programmes reviewed and published for public listing. Only active, public-listed programmes appear. If the API returns an empty list, this is usually the reason.
- A website backend that can make HTTPS requests. Browser-only JavaScript is not supported.
Your two coordinates
Every request uses two public coordinates.
| Coordinate | What it looks like | Example |
|---|---|---|
| Tenant slug | Lowercase letters, numbers, and hyphens | sanaga |
| Institution ID | A UUID: xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx | 11111111-1111-4111-8111-111111111111 |
Product owner confirmation required
Where to find these values: {{WHERE_TO_FIND_COORDINATES}}
Replace this placeholder with the exact admin-console location before the guide is published.
Keep the values together in your server configuration. The examples in this guide use these safe placeholders:
Tenant slug: your-school
Institution ID: YOUR_INSTITUTION_ID
No secret keys are needed
The tenant slug and institution ID are not confidential. The API is anonymous, read-only, and returns only information already approved for public display. You do not need an API key, access token, password, or cookie.
These values are safe to use in URLs, but you must still call the API from your server. This prevents browser cross-origin failures and gives you one place to apply caching, timeouts, and the unavailable state.
Check the institution before listing programmes
Once you have your coordinates, make the institution request from the API
reference. A 200 response
confirms that the two values identify an institution available for public use.
A 404 means you should recheck the values and the institution’s public
availability.