> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Courses

> Search and list Course records with filtering, sorting, and pagination.

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

<Note>
  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.
</Note>

## Enums

<Accordion title="eCourseVisibility — Visibility values">
  | Value | Name    |
  | ----- | ------- |
  | 1     | Public  |
  | 2     | Hidden  |
  | 3     | Private |
  | 4     | Paid    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="Course_Business" type="integer">
  Filter by iD of the Location this course belongs to.
</ParamField>

<ParamField query="Course_Business_Name" type="string">
  Filter by location name.
</ParamField>

<ParamField query="Course_Business_Address" type="string">
  Filter by location address.
</ParamField>

<ParamField query="Course_Business_TownCity" type="string">
  Filter by location town or city.
</ParamField>

<ParamField query="Course_Business_PostalCode" type="string">
  Filter by location postal code.
</ParamField>

<ParamField query="Course_Host" type="integer">
  Filter by iD of the coworker or administrator who hosts this course.
</ParamField>

<ParamField query="Course_Host_FullName" type="string">
  Filter by host full name.
</ParamField>

<ParamField query="Course_Host_CompanyName" type="string">
  Filter by host company name.
</ParamField>

<ParamField query="Course_Host_TeamNames" type="string">
  Filter by comma-separated list of teams the host belongs to.
</ParamField>

<ParamField query="Course_Title" type="string">
  Filter by course title displayed on the Members Portal.
</ParamField>

<ParamField query="Course_SummaryText" type="string">
  Filter by short summary displayed under the course title on the Members Portal (up to \~400 characters).
</ParamField>

<ParamField query="Course_FullDescription" type="string">
  Filter by full course description shown in the 'What's this course about?' section when customers open the course.
</ParamField>

<ParamField query="Course_ShowOverview" type="boolean">
  Filter by whether to display the overview section on the course page.
</ParamField>

<ParamField query="Course_HasCommunityGroup" type="boolean">
  Filter by whether the course has an associated community discussion group on the Members Portal.
</ParamField>

<ParamField query="Course_OverviewText" type="string">
  Filter by overview text displayed below the full description on the course page.
</ParamField>

<ParamField query="Course_ImageFileName" type="string">
  Filter by stored filename of the course thumbnail image (read-only; use `NewImageUrl` to set).
</ParamField>

<ParamField query="Course_NewImageUrl" type="string">
  Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ParamField>

<ParamField query="Course_ClearImage" type="boolean">
  Filter by set to true to remove the existing thumbnail image.
</ParamField>

<ParamField query="Course_LargeImageFileName" type="string">
  Filter by stored filename of the course banner/large image (read-only; use `NewLargeImageUrl` to set).
</ParamField>

<ParamField query="Course_NewLargeImageUrl" type="string">
  Filter by uRL of a new banner/large image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ParamField>

<ParamField query="Course_ClearLargeImage" type="boolean">
  Filter by set to true to remove the existing banner/large image.
</ParamField>

<ParamField query="Course_Active" type="boolean">
  Filter by whether the course is active and available to customers.
</ParamField>

<ParamField query="Course_GroupName" type="string">
  Filter by optional group label used to cluster related courses together on the Members Portal.
</ParamField>

<ParamField query="Course_DisplayOrder" type="integer">
  Filter by position of the course in listing pages; lower numbers appear first.
</ParamField>

<ParamField query="Course_ShowInHomePage" type="boolean">
  Filter by whether the course is featured on the Members Portal home page.
</ParamField>

<ParamField query="Course_Visibility" type="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).
</ParamField>

<ParamField query="Course_Tariff" type="integer">
  Filter by iD of the pricing plan (tariff) required to access this course when Visibility is Paid.
</ParamField>

<ParamField query="Course_Tariff_Name" type="string">
  Filter by pricing plan name.
</ParamField>

<ParamField query="Course_Tariff_InvoiceEvery" type="integer">
  Filter by billing frequency of the pricing plan (in months).
</ParamField>

<ParamField query="Course_Tariff_InvoiceEveryWeeks" type="integer">
  Filter by billing frequency of the pricing plan (in weeks).
</ParamField>

<ParamField query="Course_Tariff_Price" type="number">
  Filter by price of the pricing plan.
</ParamField>

<ParamField query="Course_Tariff_Currency_Code" type="string">
  Filter by currency code of the pricing plan (e.g. USD, GBP).
</ParamField>

### Range Filters

<ParamField query="from_Course_DisplayOrder" type="integer">
  Filter by position of the course in listing pages; lower numbers appear first greater than or equal to this value.
</ParamField>

<ParamField query="to_Course_DisplayOrder" type="integer">
  Filter by position of the course in listing pages; lower numbers appear first less than or equal to this value.
</ParamField>

<ParamField query="from_Course_TariffInvoiceEvery" type="integer">
  Filter by billing frequency of the pricing plan (in months) greater than or equal to this value.
</ParamField>

<ParamField query="to_Course_TariffInvoiceEvery" type="integer">
  Filter by billing frequency of the pricing plan (in months) less than or equal to this value.
</ParamField>

<ParamField query="from_Course_TariffInvoiceEveryWeeks" type="integer">
  Filter by billing frequency of the pricing plan (in weeks) greater than or equal to this value.
</ParamField>

<ParamField query="to_Course_TariffInvoiceEveryWeeks" type="integer">
  Filter by billing frequency of the pricing plan (in weeks) less than or equal to this value.
</ParamField>

<ParamField query="from_Course_TariffPrice" type="number">
  Filter by price of the pricing plan greater than or equal to this value.
</ParamField>

<ParamField query="to_Course_TariffPrice" type="number">
  Filter by price of the pricing plan less than or equal to this value.
</ParamField>

<ParamField query="from_Course_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Course_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Course_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Course_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses?Course_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Course[]">
  The list of Course records matching the query. See the [Get one Course](/rest-api/content/get-courses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **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](/rest-api/content/get-courses-by-id) 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.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```