Skip to main content
GET
/
api
/
public
/
courses
/
v2
/
{id}
/
summary
{
  "Enrolled": true,
  "Completed": true,
  "Completeness": 123,
  "LessonsCount": 123,
  "Course": {},
  "Course.Id": 123,
  "Course.Title": "<string>",
  "Course.FullDescription": "<string>",
  "Course.SummaryText": "<string>",
  "Lessons": [
    {}
  ],
  "Host": {},
  "Tariff": {}
}

​
Get Course Details

Returns the full summary for a specific course, including description, lesson count, and enrolment status. Used on the course detail page before the member chooses to enrol.

​
Authentication

No authentication required for public course details. Enrolment status fields are populated only for authenticated customers.

​
Path Parameters

​
id
number
required
Numeric identifier of the course. Returned as Id in the records from GET /api/public/courses/v2.

​
Query Parameters

​
_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

​
Response

Returns a CourseSummary object. The course metadata is nested inside a Course property.
​
Enrolled
boolean
Whether the authenticated customer is enrolled in this course.
​
Completed
boolean
Whether the authenticated customer has completed this course.
​
Completeness
number
Completion percentage (0–100).
​
LessonsCount
number
Total number of lessons in the course.
​
Course
Course
The course metadata object.
​
Course.Id
number
required
Unique identifier for the course.
​
Course.Title
string
required
Display title of the course.
​
Course.FullDescription
string
Full course description. May contain HTML.
​
Course.SummaryText
string
Short summary text for the course.
​
Lessons
Lesson[]
Array of lesson summaries for the course.
​
Host
Coworker
The host/instructor of the course.
​
Tariff
Tariff
Pricing information for the course, if applicable.

​
Examples

​
Fetch course summary

GET /api/public/courses/v2/42/summary

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: course } = useTypedData(httpClient, endpoints.courses.details(42))