GET

api

public

courses

{id}

summary

Get Course Details

curl --request GET \
  --url https://spaces.nexudus.com/api/public/courses/v2/{id}/summary \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/courses/v2/{id}/summary"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/courses/v2/{id}/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

number

required

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

Query Parameters

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.

boolean

Whether the authenticated customer is enrolled in this course.

boolean

Whether the authenticated customer has completed this course.

number

Completion percentage (0–100).

number

Total number of lessons in the course.

Course

The course metadata object.

number

required

Unique identifier for the course.

string

required

Display title of the course.

string

Full course description. May contain HTML.

string

Short summary text for the course.

Lesson[]

Array of lesson summaries for the course.

Coworker

The host/instructor of the course.

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))

List My CoursesReturns all courses the authenticated customer is enrolled in.

Get Course Details

curl --request GET \
  --url https://spaces.nexudus.com/api/public/courses/v2/{id}/summary \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/courses/v2/{id}/summary"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/courses/v2/{id}/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

​Authentication

​Path Parameters

​Query Parameters

​Response

​Examples

​Fetch course summary

​TypeScript Integration

Get Course Details

Authentication

Path Parameters

Query Parameters

Response

Examples

Fetch course summary

TypeScript Integration