Courses
Search Courses
Search and list Course records with filtering, sorting, and pagination.
GET
Search Courses
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
Courses can optionally display a community discussion group (
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 |
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
eCourseVisibility — Visibility values
| Value | Name |
|---|---|
| 1 | Public |
| 2 | Hidden |
| 3 | Private |
| 4 | Paid |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the Location this course belongs to.
Filter by location name.
Filter by location address.
Filter by location town or city.
Filter by location postal code.
Filter by iD of the coworker or administrator who hosts this course.
Filter by host full name.
Filter by host company name.
Filter by comma-separated list of teams the host belongs to.
Filter by course title displayed on the Members Portal.
Filter by short summary displayed under the course title on the Members Portal (up to ~400 characters).
Filter by full course description shown in the ‘What’s this course about?’ section when customers open the course.
Filter by whether to display the overview section on the course page.
Filter by whether the course has an associated community discussion group on the Members Portal.
Filter by overview text displayed below the full description on the course page.
Filter by stored filename of the course thumbnail image (read-only; use
NewImageUrl to set).Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
Filter by set to true to remove the existing thumbnail image.
Filter by stored filename of the course banner/large image (read-only; use
NewLargeImageUrl to set).Filter by uRL of a new banner/large image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
Filter by set to true to remove the existing banner/large image.
Filter by whether the course is active and available to customers.
Filter by optional group label used to cluster related courses together on the Members Portal.
Filter by position of the course in listing pages; lower numbers appear first.
Filter by whether the course is featured on the Members Portal home page.
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).
Filter by iD of the pricing plan (tariff) required to access this course when Visibility is Paid.
Filter by pricing plan name.
Filter by billing frequency of the pricing plan (in months).
Filter by billing frequency of the pricing plan (in weeks).
Filter by price of the pricing plan.
Filter by currency code of the pricing plan (e.g. USD, GBP).
Range Filters
Filter by position of the course in listing pages; lower numbers appear first greater than or equal to this value.
Filter by position of the course in listing pages; lower numbers appear first less than or equal to this value.
Filter by billing frequency of the pricing plan (in months) greater than or equal to this value.
Filter by billing frequency of the pricing plan (in months) less than or equal to this value.
Filter by billing frequency of the pricing plan (in weeks) greater than or equal to this value.
Filter by billing frequency of the pricing plan (in weeks) less than or equal to this value.
Filter by price of the pricing plan greater than or equal to this value.
Filter by price of the pricing plan less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Title
Range filters
Response
200
The list of Course records matching the query. See the Get one Course endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search Courses