curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/courses?offset=0' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
import requests
url = "https://YOURSITE.konstant.ly/openapi/v1/courses"
headers = {
"X-API-KEY": "1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv"
}
params = {
"offset": 0 # Optional: for pagination
}
response = requests.get(url, headers=headers, params=params)
courses = response.json()
for course in courses['courses']:
print(f"Course: {course['name']}")
const axios = require('axios');
async function listCourses(offset = 0) {
try {
const response = await axios.get('https://YOURSITE.konstant.ly/openapi/v1/courses', {
headers: {
'X-API-KEY': '1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
},
params: {
offset: offset
}
});
return response.data;
} catch (error) {
console.error('Error fetching courses:', error.message);
throw error;
}
}
// Example usage
listCourses()
.then(data => {
console.log(`Found ${data.totalCount} courses`);
data.courses.forEach(course => {
console.log(`- ${course.name}`);
});
})
.catch(error => {
console.error('Failed to list courses:', error);
});
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://YOURSITE.konstant.ly/openapi/v1/courses',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
]
]);
$response = curl_exec($ch);
$courses = json_decode($response, true);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
}
curl_close($ch);
foreach ($courses['courses'] as $course) {
echo "Course: " . $course['name'] . "\n";
}
?>
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ListCourses {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://YOURSITE.konstant.ly/openapi/v1/courses"))
.header("X-API-KEY", "1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv")
.GET()
.build();
try {
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
{
"courses": [
{
"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"
}
}
],
"totalCount": 1
}
Courses
List Courses
Get a list of courses (20 per page)
GET
/
courses
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/courses?offset=0' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
import requests
url = "https://YOURSITE.konstant.ly/openapi/v1/courses"
headers = {
"X-API-KEY": "1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv"
}
params = {
"offset": 0 # Optional: for pagination
}
response = requests.get(url, headers=headers, params=params)
courses = response.json()
for course in courses['courses']:
print(f"Course: {course['name']}")
const axios = require('axios');
async function listCourses(offset = 0) {
try {
const response = await axios.get('https://YOURSITE.konstant.ly/openapi/v1/courses', {
headers: {
'X-API-KEY': '1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
},
params: {
offset: offset
}
});
return response.data;
} catch (error) {
console.error('Error fetching courses:', error.message);
throw error;
}
}
// Example usage
listCourses()
.then(data => {
console.log(`Found ${data.totalCount} courses`);
data.courses.forEach(course => {
console.log(`- ${course.name}`);
});
})
.catch(error => {
console.error('Failed to list courses:', error);
});
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://YOURSITE.konstant.ly/openapi/v1/courses',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
]
]);
$response = curl_exec($ch);
$courses = json_decode($response, true);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
}
curl_close($ch);
foreach ($courses['courses'] as $course) {
echo "Course: " . $course['name'] . "\n";
}
?>
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ListCourses {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://YOURSITE.konstant.ly/openapi/v1/courses"))
.header("X-API-KEY", "1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv")
.GET()
.build();
try {
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
{
"courses": [
{
"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"
}
}
],
"totalCount": 1
}
Retrieve a paginated list of all courses on your platform.
Request Headers
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.
Query Parameters
integer
Entry number to start listing from. Use this for pagination.Example:
20 to get the second page of resultsResponse
array
required
Array of course objects
Show Course object properties
Show Course object properties
integer
required
Course ID
string
required
Course name
string
required
Course annotation
boolean
required
Indicates whether the course is a draft
integer
required
Creation timestamp
integer
required
Last update timestamp
integer
required
Publication timestamp
integer
required
The total number of courses
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/courses?offset=0' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
import requests
url = "https://YOURSITE.konstant.ly/openapi/v1/courses"
headers = {
"X-API-KEY": "1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv"
}
params = {
"offset": 0 # Optional: for pagination
}
response = requests.get(url, headers=headers, params=params)
courses = response.json()
for course in courses['courses']:
print(f"Course: {course['name']}")
const axios = require('axios');
async function listCourses(offset = 0) {
try {
const response = await axios.get('https://YOURSITE.konstant.ly/openapi/v1/courses', {
headers: {
'X-API-KEY': '1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
},
params: {
offset: offset
}
});
return response.data;
} catch (error) {
console.error('Error fetching courses:', error.message);
throw error;
}
}
// Example usage
listCourses()
.then(data => {
console.log(`Found ${data.totalCount} courses`);
data.courses.forEach(course => {
console.log(`- ${course.name}`);
});
})
.catch(error => {
console.error('Failed to list courses:', error);
});
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://YOURSITE.konstant.ly/openapi/v1/courses',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
]
]);
$response = curl_exec($ch);
$courses = json_decode($response, true);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
}
curl_close($ch);
foreach ($courses['courses'] as $course) {
echo "Course: " . $course['name'] . "\n";
}
?>
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ListCourses {
public static void main(String[] args) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://YOURSITE.konstant.ly/openapi/v1/courses"))
.header("X-API-KEY", "1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv")
.GET()
.build();
try {
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
{
"courses": [
{
"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"
}
}
],
"totalCount": 1
}
Was this page helpful?
⌘I