Skip to main content
GET
List Courses

List Courses

Returns a paginated list of published courses for the current location. Supports filtering by category name, keyword search, and a flag to only return courses marked for the home page.
A course is a structured learning programme created by the space operator, consisting of multiple lessons. Members can enrol, track progress, and complete lessons through the portal.

Authentication

No authentication required.

Query Parameters

number
required
1-based page number.
number
required
Number of courses per page.
string
Filter by category name. Omit to return courses across all categories.
Keyword filter applied to course name and description. URL-encoded.
boolean
When true, returns only courses flagged to appear on the portal home page.
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. Example: _shape=Courses.Records.Name,Courses.Records.Description,Categories.

Response

Returns a CourseList object containing available categories and a paginated list of course summaries.
string[]
Array of all available course category names for filtering.
ApiListResult<CourseStatus>
Paginated wrapper containing course records.
CourseStatus[]
Array of course summaries for the current page.
number
Current page number.
number
Total number of matching courses.
number
Total number of pages.
boolean
Whether there are more pages after the current one.

Examples

Fetch first page of courses

TypeScript Integration