Course Group By Id

Returns a single course group by its unique identifier

Returns a single course group by its unique identifier.

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

Example request

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

Parameters

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

Example response

{
  "data": {
    "APICourseGroupById": {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "slug": "example-slug",
      "kind": "microCourse",
      "status": "draft",
      "isTemplate": true,
      "language": "string",
      "contentType": "string",
      "authors": [
        "string"
      ],
      "description": "string",
      "displayCourseId": "00000000-0000-0000-0000-000000000000",
      "courseCount": 0,
      "asset": "string",
      "assetAltText": "string",
      "detailAsset": "string",
      "detailAssetAltText": "string",
      "metaTitle": "string",
      "metaDescription": "string",
      "customFields": {},
      "isbn": "string",
      "source": "string",
      "externalPurchaseUrl": "string",
      "externalDetailUrl": "string"
    }
  }
}

Response fields

Field	Type	Description
`id`	`uuid`	Unique identifier of the course group.
`title`	`string`	Display title of the course group.
`slug`	`string`	URL-friendly identifier used in the course group's path.
`kind`	`CourseGroupKind`	Category type of the course group (e.g., `microCourse`).
`status`	`Status`	Publication status of the course group (e.g., `draft`).
`isTemplate`	`boolean`	Indicates whether the course group is a template.
`language`	`string`	Language of the course group content.
`contentType`	`string`	Content type classification assigned to the course group.
`authors`	`string[]`	List of authors associated with the course group.
`description`	`string`	Long-form description of the course group.
`displayCourseId`	`uuid`	Identifier of the course used to represent the group on listing pages.
`courseCount`	`integer`	Total number of courses within the course group.
`asset`	`string`	URL of the thumbnail or card image for the course group.
`assetAltText`	`string`	Accessibility alt text for the thumbnail image.
`detailAsset`	`string`	URL of the hero or detail-page image for the course group.
`detailAssetAltText`	`string`	Accessibility alt text for the detail-page image.
`metaTitle`	`string`	SEO meta title for the course group page.
`metaDescription`	`string`	SEO meta description for the course group page.
`customFields`	`object`	Key-value pairs of custom metadata fields defined for the course group.
`isbn`	`string`	ISBN assigned to the course group, if applicable.
`source`	`string`	Origin or provider source of the course group content.
`externalPurchaseUrl`	`string`	URL to an external page where the course group can be purchased.
`externalDetailUrl`	`string`	URL to an external detail or marketing page for the course group.