Skip to main content
GET
Get a course

Authorizations

X-API-Key
string
header
required

Your publishable Catalogue API key (vak_pub_…).

Path Parameters

id
string
required

Query Parameters

language
string

A code from GET /site languages. Shows that language's version of the course (title, url, price). Ignored when the site has course languages off.

Response

The course.

id
string
required

The course id. Stable across language versions. Use it in GET /courses/{id}.

title
string
required

Title of the version shown (see language).

subtitle
string | null
required

Plain text, at most 300 characters: the card text.

image_url
string | null
required

Card image (absolute URL).

url
string | null
required

The course's page on the hosted catalogue site, where enrolment, cart and checkout happen. Includes the version's query string. Null when the course page address is not configured.

formats
object[]
required
stream
object | null
required

A stream or category a course belongs to.

category
object | null
required

A stream or category a course belongs to.

languages
object[]
required

Languages the course is available in. Empty when the site has course languages off.

tags
string[]
required

Course tags as authored (original case).

level
string | null
required

Level of the version shown; null for a course without named levels.

availability
enum<string>
required

available: can be bought or enrolled now. coming_soon: announced, not on sale. not_started: enrolment opens later. closed: enrolment ended or inactive.

Available options:
available,
coming_soon,
not_started,
closed
price_visible
boolean
required

False when the institute hides prices and this course is paid. Show "see price" and link to url.

price
object | null
required

Null when the course is not on sale now (see availability) or its price is hidden.

instructors
object[]
required
rating
number | null
required

Average rating, or null when there is none.

created_at
string<date-time> | null
required

ISO-8601 UTC. The newest version's creation time; sort=newest uses it.

variants
object[]
required

Every version, in catalogue order.

description_html
string | null
required

Sanitised HTML (jsoup relaxed safelist; images http(s) only).

description_text
string | null
required

Plain-text version.

about_html
string | null
required
about_text
string | null
required
why_learn_html
string | null
required
who_should_learn_html
string | null
required
mode
enum<string> | null
required

How the course is taught.

Available options:
self_paced,
live,
null
faqs
object[]
required
preview_video
object | null
required
authors
object[]
required
series
object | null
required

Null unless a learning path of 2+ steps lists this course.

seo
object
required
structured_data
object
required

A schema.org Course (JSON-LD) object, ready for <script type="application/ld+json">.