Skip to main content
GET
/
courses
/
{courseId}
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/courses/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": 123,
    "name": "Course name",
    "annotation": "Course annotation",
    "isDraft": false,
    "createdAt": 1507807711,
    "updatedAt": 1507808372,
    "publishedAt": 1508225229,
    "image": {
    "id": 1234,
    "original": "http://example.com/images/original/1234.jpg",
    "mini": "http://example.com/images/mini/1234.jpg",
    "small": "http://example.com/images/small/1234.jpg"
},
    "description": "Detailed course description",
    "attachedFiles": [
{
    "name": "myfile.txt",
    "size": 123,
    "url": "http://example.com/files/myfile.txt",
    "mime": "text/plain"
}
    ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.konstantly.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve detailed information about a specific course by its ID.

​
Path Parameters

​
courseId
integer
required
The unique identifier of the course

​
Request Headers

​
X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

​
Response

​
id
integer
required
Course ID
​
name
string
required
Course name
​
annotation
string
required
Course annotation
​
isDraft
boolean
required
Indicates whether the course is a draft
​
createdAt
integer
required
Creation timestamp
​
updatedAt
integer
required
Last update timestamp
​
publishedAt
integer
required
Publication timestamp
​
image
object
Course cover image details
​
description
string
required
Course description
​
attachedFiles
array
required
Attached files

​
Error Responses

​
404
object
Returned when the course is not found
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/courses/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": 123,
    "name": "Course name",
    "annotation": "Course annotation",
    "isDraft": false,
    "createdAt": 1507807711,
    "updatedAt": 1507808372,
    "publishedAt": 1508225229,
    "image": {
    "id": 1234,
    "original": "http://example.com/images/original/1234.jpg",
    "mini": "http://example.com/images/mini/1234.jpg",
    "small": "http://example.com/images/small/1234.jpg"
},
    "description": "Detailed course description",
    "attachedFiles": [
{
    "name": "myfile.txt",
    "size": 123,
    "url": "http://example.com/files/myfile.txt",
    "mime": "text/plain"
}
    ]
}