Retrieve a course
curl --request GET \
--url https://api.example.com/v1/courses/{id}import requests
url = "https://api.example.com/v1/courses/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/courses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/courses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/courses/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/courses/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/courses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyCourses
Retrieve a course
Fetch a course by ID, optionally inlining related resources.
GET
/
v1
/
courses
/
{id}
Retrieve a course
curl --request GET \
--url https://api.example.com/v1/courses/{id}import requests
url = "https://api.example.com/v1/courses/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/courses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/courses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/courses/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/courses/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/courses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyPath parameters
The course ID.
Query parameters
Inline related resources. Up to 3 levels deep. Allowed paths:
cohorts, cohorts.units, cohorts.lessons,
cohorts.lessons.activities, cohorts.lessons.content.Returns
The Course.Examples
const course = await hk.courses.retrieve("crs_123", {
expand: ["cohorts.lessons"],
});
$course = $hk->courses->retrieve('crs_123', [
'expand' => ['cohorts.lessons'],
]);
course = hk.courses.retrieve(
"crs_123",
expand=["cohorts.lessons"],
)
curl "https://api.hawkings.education/v1/courses/crs_123?expand=cohorts.lessons" \
-H "x-api-key: $HAWKINGS_API_KEY" \
-H "X-Learning-Platform-Code: $HAWKINGS_PLATFORM_CODE"
⌘I