Course Groups

Returns a paginated list of course groups. Filter results by kind, template status, or archived state

Returns a paginated list of course groups. Filter results by kind, template status, or archived state.

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

Example request

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

Parameters

Name	Type	Required	Location	Description
`kind`	`CourseGroupKind`	No	query	Filters results to course groups of the specified kind (e.g., `microCourse`).
`isTemplate`	`boolean`	No	query	When `true`, returns only course groups marked as templates.
`archived`	`boolean`	No	query	When `true`, returns only archived course groups.
`page`	`integer`	No	query	Page number to retrieve in the paginated result set.
`perPage`	`integer`	No	query	Number of course groups to return per page.

Example response

{
  "data": {
    "APICourseGroups": {
      "pageInfo": {
        "perPage": 0,
        "currentPage": 0,
        "total": 0,
        "hasMore": true
      },
      "courseGroups": [
        {
          "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
        }
      ]
    }
  }
}

Response fields

Field	Type	Description
`pageInfo`	`PageInfo`	Pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of course groups returned per page.
`pageInfo.currentPage`	`integer`	The current page number in the paginated result set.
`pageInfo.total`	`integer`	Total number of course groups matching the query.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`courseGroups`	`APICourseGroupInfo[]`	Array of course group objects matching the query.
`courseGroups.id`	`uuid`	Unique identifier for the course group.
`courseGroups.title`	`string`	Display title of the course group.
`courseGroups.slug`	`string`	URL-friendly identifier for the course group.
`courseGroups.kind`	`CourseGroupKind`	The category or type of the course group (e.g., `microCourse`).
`courseGroups.status`	`Status`	Publication status of the course group (e.g., `draft`).
`courseGroups.isTemplate`	`boolean`	Indicates whether the course group is marked as a template.
`courseGroups.language`	`string`	Language code of the course group's content.
`courseGroups.contentType`	`string`	The content type associated with the course group.
`courseGroups.authors`	`string[]`	List of author names or identifiers credited to the course group.
`courseGroups.description`	`string`	Short description of the course group.
`courseGroups.displayCourseId`	`uuid`	Unique identifier of the course used as the display representative for this group.
`courseGroups.courseCount`	`integer`	Total number of courses contained in the course group.