Course Group Display Course

Returns the display course associated with the specified course group

Returns the display course associated with the specified course group.

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

Example request

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

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The unique identifier of the course group.

Example response

{
  "data": {
    "APICourseGroupDisplayCourse": {
      "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
`id`	`uuid`	Unique identifier of the display course.
`title`	`string`	Display name of the course.
`slug`	`string`	URL-friendly identifier for the course.
`status`	`Status`	Publication status of the course (e.g., `draft`, `published`).
`courseStartDate`	`ISO 8601 timestamp`	Date and time when the course becomes available to learners.
`courseEndDate`	`ISO 8601 timestamp`	Date and time when the course is no longer available to learners.
`enrollmentStartDate`	`ISO 8601 timestamp`	Date and time when enrollment opens for the course.
`enrollmentEndDate`	`ISO 8601 timestamp`	Date and time when enrollment closes for the course.
`seatsLimit`	`integer`	Maximum number of learners who can enroll in the course.
`seatsUsed`	`integer`	Number of seats currently occupied by enrolled learners.
`isDisplayCourse`	`boolean`	Indicates whether this course is designated as the display course for the group.