Course Group Courses

Returns a paginated list of courses belonging to the specified course group

Returns a paginated list of courses belonging to the specified course group.

GEThttps://example.thoughtindustries.com/incoming/v2/courseGroups/:id/courses

Example request

curl "https://example.thoughtindustries.com/incoming/v2/courseGroups/:id/courses" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The id identifier.
`activeOnly`	`boolean`	No	query	When `true`, returns only courses that are currently active.
`page`	`integer`	No	query	The page number to retrieve in the paginated result set.
`perPage`	`integer`	No	query	The number of courses to return per page.

Example response

{
  "data": {
    "APICourseGroupCourses": {
      "pageInfo": {
        "perPage": 0,
        "currentPage": 0,
        "total": 0,
        "hasMore": true
      },
      "courses": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "title": "string",
          "slug": "example-slug",
          "status": "draft",
          "courseStartDate": "2024-01-01T00:00:00.000Z",
          "courseEndDate": "2024-01-01T00:00:00.000Z",
          "enrollmentStartDate": "2024-01-01T00:00:00.000Z",
          "enrollmentEndDate": "2024-01-01T00:00:00.000Z",
          "seatsLimit": 0,
          "seatsUsed": 0,
          "isDisplayCourse": true
        }
      ]
    }
  }
}

Response fields

Field	Type	Description
`pageInfo`	`PageInfo`	Pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of courses returned per page.
`pageInfo.currentPage`	`integer`	The current page number in the result set.
`pageInfo.total`	`integer`	Total number of courses across all pages.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`courses`	`APICourseInfo[]`	Array of courses belonging to the course group.
`courses.id`	`uuid`	Unique identifier for the course.
`courses.title`	`string`	Display title of the course.
`courses.slug`	`string`	URL-friendly identifier for the course.
`courses.status`	`Status`	Publication status of the course (e.g., `draft`, `published`).
`courses.courseStartDate`	`ISO 8601 timestamp`	Date and time when the course becomes available to learners, in ISO 8601 format.
`courses.courseEndDate`	`ISO 8601 timestamp`	Date and time when the course is no longer available to learners, in ISO 8601 format.
`courses.enrollmentStartDate`	`ISO 8601 timestamp`	Date and time when enrollment opens for the course, in ISO 8601 format.
`courses.enrollmentEndDate`	`ISO 8601 timestamp`	Date and time when enrollment closes for the course, in ISO 8601 format.
`courses.seatsLimit`	`integer`	Maximum number of learners that can enroll in the course. A value of `0` indicates no limit.
`courses.seatsUsed`	`integer`	Number of seats currently occupied by enrolled learners.
`courses.isDisplayCourse`	`boolean`	Indicates whether this course is designated as the display course for the course group.