Get one Course

GET

api

content

courses

{id}

Get one Course

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

import requests

url = "https://spaces.nexudus.com/api/content/courses/{id}"

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/content/courses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessAddress": "<string>",
  "BusinessTownCity": "<string>",
  "BusinessPostalCode": "<string>",
  "HostId": 123,
  "HostFullName": "<string>",
  "HostCompanyName": "<string>",
  "HostTeamNames": "<string>",
  "Title": "<string>",
  "SummaryText": "<string>",
  "FullDescription": "<string>",
  "ShowOverview": true,
  "HasCommunityGroup": true,
  "OverviewText": "<string>",
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "LargeImageFileName": "<string>",
  "NewLargeImageUrl": "<string>",
  "ClearLargeImageFile": true,
  "Active": true,
  "GroupName": "<string>",
  "DisplayOrder": 123,
  "ShowInHomePage": true,
  "Visibility": 123,
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "TariffPrice": 123,
  "TariffCurrencyCode": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Course is a structured learning module published to customers through the Members Portal. Courses are organised into sections (milestones) and lessons (individual content units). They can be used for internal training, community building, or self-learning offers. Courses belong to a Location and are assigned a Host (a customer or administrator) who is responsible for its content. You can control who can access a course using the Visibility field:

Visibility	Meaning
Public	Visible and accessible to everyone on the Members Portal
Hidden	Not listed on the Members Portal but accessible via a direct link
Private	Only accessible to members who have been explicitly added
Paid	Requires purchase via the linked `TariffId` pricing plan

Courses can optionally display a community discussion group (HasCommunityGroup), be featured on the portal home page (ShowInHomePage), and be grouped together under a GroupName for easier navigation.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Course-Read role.

Path Parameters

integer

required

The Id of the Course record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/courses/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courses/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/courses/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the Location this course belongs to.

string

Location name.

string

Location address.

string

Location town or city.

string

Location postal code.

integer

ID of the coworker or administrator who hosts this course.

string

Host full name.

string

Host company name.

string

Comma-separated list of teams the host belongs to.

string

Course title displayed on the Members Portal.

string

Short summary displayed under the course title on the Members Portal (up to ~400 characters).

string

Full course description shown in the ‘What’s this course about?’ section when customers open the course.

boolean

Whether to display the overview section on the course page.

boolean

Whether the course has an associated community discussion group on the Members Portal.

string

Overview text displayed below the full description on the course page.

string

Stored filename of the course thumbnail image (read-only; use NewImageUrl to set).

string

URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).

boolean

Set to true to remove the existing thumbnail image.

string

Stored filename of the course banner/large image (read-only; use NewLargeImageUrl to set).

string

URL of a new banner/large image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).

boolean

Set to true to remove the existing banner/large image.

boolean

Whether the course is active and available to customers.

string

Optional group label used to cluster related courses together on the Members Portal.

integer

Position of the course in listing pages; lower numbers appear first.

boolean

Whether the course is featured on the Members Portal home page.

integer

Access control for the course: Public (1), Hidden from listing but accessible via link (2), Private/invite-only (3), or Paid via TariffId (4). See eCourseVisibility enum values: 1 = Public, 2 = Hidden, 3 = Private, 4 = Paid.

integer

ID of the pricing plan (tariff) required to access this course when Visibility is Paid.

string

Pricing plan name.

integer

Billing frequency of the pricing plan (in months).

integer

Billing frequency of the pricing plan (in weeks).

number

Price of the pricing plan.

string

Currency code of the pricing plan (e.g. USD, GBP).

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessAddress": null,
  "BusinessTownCity": null,
  "BusinessPostalCode": null,
  "HostId": 0,
  "HostFullName": null,
  "HostCompanyName": null,
  "HostTeamNames": null,
  "Title": "",
  "SummaryText": null,
  "FullDescription": null,
  "ShowOverview": false,
  "HasCommunityGroup": false,
  "OverviewText": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "LargeImageFileName": null,
  "NewLargeImageUrl": null,
  "ClearLargeImageFile": null,
  "Active": false,
  "GroupName": null,
  "DisplayOrder": 0,
  "ShowInHomePage": false,
  "Visibility": 0,
  "TariffId": null,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": null,
  "TariffCurrencyCode": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Course Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoursesRetrieve multiple Course records by their Ids in a single request.

Get one Course

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

import requests

url = "https://spaces.nexudus.com/api/content/courses/{id}"

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/content/courses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessAddress": "<string>",
  "BusinessTownCity": "<string>",
  "BusinessPostalCode": "<string>",
  "HostId": 123,
  "HostFullName": "<string>",
  "HostCompanyName": "<string>",
  "HostTeamNames": "<string>",
  "Title": "<string>",
  "SummaryText": "<string>",
  "FullDescription": "<string>",
  "ShowOverview": true,
  "HasCommunityGroup": true,
  "OverviewText": "<string>",
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "LargeImageFileName": "<string>",
  "NewLargeImageUrl": "<string>",
  "ClearLargeImageFile": true,
  "Active": true,
  "GroupName": "<string>",
  "DisplayOrder": 123,
  "ShowInHomePage": true,
  "Visibility": 123,
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "TariffPrice": 123,
  "TariffCurrencyCode": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200