Search Courses

GET

api

content

courses

Search Courses

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

import requests

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

eCourseVisibility — Visibility values

Value	Name
1	Public
2	Hidden
3	Private
4	Paid

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the Location this course belongs to.

string

Filter by location name.

string

Filter by location address.

string

Filter by location town or city.

string

Filter by location postal code.

integer

Filter by iD of the coworker or administrator who hosts this course.

string

Filter by host full name.

string

Filter by host company name.

string

Filter by comma-separated list of teams the host belongs to.

string

Filter by course title displayed on the Members Portal.

string

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

string

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

boolean

Filter by whether to display the overview section on the course page.

boolean

Filter by whether the course has an associated community discussion group on the Members Portal.

string

Filter by overview text displayed below the full description on the course page.

string

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

string

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

boolean

Filter by set to true to remove the existing thumbnail image.

string

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

string

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

boolean

Filter by set to true to remove the existing banner/large image.

boolean

Filter by whether the course is active and available to customers.

string

Filter by optional group label used to cluster related courses together on the Members Portal.

integer

Filter by position of the course in listing pages; lower numbers appear first.

boolean

Filter by whether the course is featured on the Members Portal home page.

integer

Filter by access control for the course: Public (1), Hidden from listing but accessible via link (2), Private/invite-only (3), or Paid via TariffId (4).

integer

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

string

Filter by pricing plan name.

integer

Filter by billing frequency of the pricing plan (in months).

integer

Filter by billing frequency of the pricing plan (in weeks).

number

Filter by price of the pricing plan.

string

Filter by currency code of the pricing plan (e.g. USD, GBP).

Range Filters

integer

Filter by position of the course in listing pages; lower numbers appear first greater than or equal to this value.

integer

Filter by position of the course in listing pages; lower numbers appear first less than or equal to this value.

integer

Filter by billing frequency of the pricing plan (in months) greater than or equal to this value.

integer

Filter by billing frequency of the pricing plan (in months) less than or equal to this value.

integer

Filter by billing frequency of the pricing plan (in weeks) greater than or equal to this value.

integer

Filter by billing frequency of the pricing plan (in weeks) less than or equal to this value.

number

Filter by price of the pricing plan greater than or equal to this value.

number

Filter by price of the pricing plan less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/courses?page=1&size=15&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courses?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Title',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/courses',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Title

curl -X GET \
  "https://spaces.nexudus.com/api/content/courses?Course_Title=example-value&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courses?' + new URLSearchParams({
    Course_Title: 'example-value',
    orderBy: 'Title',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/courses',
    params={
        'Course_Title': 'example-value',
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/courses?from_Course_UpdatedOn=2025-01-01T00:00&to_Course_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courses?' + new URLSearchParams({
    from_Course_UpdatedOn: '2025-01-01T00:00',
    to_Course_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/courses',
    params={
        'from_Course_UpdatedOn': '2025-01-01T00:00',
        'to_Course_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Course[]

The list of Course records matching the query. See the Get one Course endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Course. The following fields are not populated in the Records[] response: FullDescription, ShowOverview, OverviewText, Active, ShowInHomePage, Visibility.To get all fields, fetch the full record using the Get one Course endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessAddress": null,
      "BusinessTownCity": null,
      "BusinessPostalCode": null,
      "HostId": 0,
      "HostFullName": null,
      "HostCompanyName": null,
      "HostTeamNames": null,
      "Title": "",
      "SummaryText": null,
      "HasCommunityGroup": false,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "LargeImageFileName": null,
      "NewLargeImageUrl": null,
      "ClearLargeImageFile": null,
      "GroupName": null,
      "DisplayOrder": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CourseRetrieve a single Course record by its Id.

Search Courses

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

import requests

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Title

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200