Website API

Overview

Every endpoint is scoped to one organisation by its slug, the first part of its website address. For acme.vlearned.com the slug is acme.

Quick start

Fetch an organisation's latest courses:

curl -H "Accept: application/json" \
  "https://vlearned.com/apis/v1/organisations/your-organisation/courses?per_page=6"

The same request from a web page:

const res = await fetch('https://vlearned.com/apis/v1/organisations/your-organisation/courses?per_page=6', {
  headers: { Accept: 'application/json' },
});
const { data, meta } = await res.json();
data.forEach((course) => console.log(course.title, course.url));

Responses and errors

Single records are wrapped in data. Lists that support paging also include meta:

{
  "data": [ { "id": 12, "slug": "intro-to-data", "title": "Intro to Data", "...": "..." } ],
  "meta": { "current_page": 1, "last_page": 3, "per_page": 12, "total": 31, "organisation": "your-organisation" }
}

Rate limits

Read endpoints allow 120 requests per minute per IP address. Enquiry submissions allow 5 per minute. The X-RateLimit-Limit and X-RateLimit-Remaining headers show your current allowance. Cache responses on your side where you can.

Organisation

Learning catalogue

Website content

Enquiries

Examples

Course object

{
  "id": 12,
  "slug": "intro-to-data",
  "title": "Intro to Data",
  "short_description": "Learn the basics of data analysis.",
  "thumbnail_url": "https://...",
  "category": "Data",
  "price": "49.00",
  "discount_price": null,
  "currency": "MYR",
  "is_free": false,
  "level": "beginner",
  "total_lessons": 18,
  "instructor": { "id": 7, "name": "Aisha Rahman" },
  "published_at": "2026-09-01T08:00:00+00:00",
  "url": "https://your-organisation.vlearned.com/catalogue/intro-to-data",
  "admission": {
    "mode": "apply",
    "applications_open": true,
    "deadline": "2026-12-15",
    "questions": ["What is your highest qualification?"],
    "action_url": "https://your-organisation.vlearned.com/apply/course/intro-to-data"
  }
}

Enrolment and applications

Every course and programme includes an admission object. When mode is enrol, learners join directly (paid courses go through checkout first). When it is apply, learners submit an application that the organisation reviews. Send learners to action_url: they sign in or create an account on the organisation's website and then enrol, pay or apply there. Enrolment and payment always happen on the organisation's website, never through this API.

Send an enquiry

curl -X POST "https://vlearned.com/apis/v1/organisations/your-organisation/enquiries" \
  -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{"name":"Sam Lee","email":"sam@example.com","subject":"January intake","message":"Is there still space in the January intake?"}'

{ "data": { "id": "9d2c...", "received_at": "2026-10-12T09:30:00+00:00" }, "message": "Thank you. Your message has been received." }

Show upcoming events on any website

<ul id="events"></ul>
<script>
  fetch('https://vlearned.com/apis/v1/organisations/your-organisation/events?per_page=3')
    .then((r) => r.json())
    .then(({ data }) => {
      document.getElementById('events').innerHTML = data
        .map((e) => `<li><a href="${e.url}">${e.title}</a> – ${new Date(e.starts_at).toLocaleDateString()}</li>`)
        .join('');
    });
</script>

Other APIs

Signed-in features such as enrolments, progress, assessments and administration use the authenticated platform API. Read about tokens, scopes and endpoints in the platform API reference.

Need higher limits, webhooks or help with an integration? Contact us at info@aismartuallearning.com.