Course Topics

Returns a paginated list of topics belonging to the specified course

Returns a paginated list of topics belonging to the specified course.

GEThttps://example.thoughtindustries.com/incoming/v2/topics/course/:courseId

Example request

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

Parameters

Name	Type	Required	Location	Description
`courseId`	`uuid`	Yes	path	The courseId identifier.
`page`	`integer`	No	query	Page number to retrieve in the paginated result set.
`perPage`	`integer`	No	query	Number of topics to return per page.

Example response

{
  "data": {
    "APICourseTopics": {
      "pageInfo": {
        "perPage": 0,
        "currentPage": 0,
        "total": 0,
        "hasMore": true
      },
      "topics": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "originalId": "00000000-0000-0000-0000-000000000000",
          "title": "string",
          "type": "ad",
          "quizQuestions": [
            "00000000-0000-0000-0000-000000000000"
          ],
          "preTextBlock": "string",
          "postTextBlock": "string",
          "updatedAt": "2024-01-01T00:00:00.000Z",
          "resultsMessage": "string",
          "passMessage": "string",
          "failMessage": "string",
          "navigationDisabled": true,
          "instructorAssessment": true,
          "questionSkipEnabled": true,
          "isProctored": true,
          "allowToResume": true,
          "assetType": "string"
        }
      ]
    }
  }
}

Response fields

Field	Type	Description
`pageInfo`	`PageInfo`	Pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of topics returned per page.
`pageInfo.currentPage`	`integer`	The current page number in the result set.
`pageInfo.total`	`integer`	Total number of topics across all pages.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results exist.
`topics`	`Topic[]`	Array of topic objects belonging to the course.
`topics.id`	`uuid`	Unique identifier for the topic.
`topics.originalId`	`uuid`	Identifier referencing the topic's original source, used when the topic was copied from another course.
`topics.title`	`string`	Display title of the topic.
`topics.type`	`TopicType`	Content type of the topic (e.g., `ad`, quiz, video).
`topics.quizQuestions`	`uuid[]`	List of question IDs associated with the topic, applicable when the topic type is a quiz or assessment.
`topics.preTextBlock`	`string`	HTML or plain-text content displayed before the main topic content.
`topics.postTextBlock`	`string`	HTML or plain-text content displayed after the main topic content.
`topics.updatedAt`	`ISO 8601 timestamp`	Date and time the topic was last updated, in ISO 8601 format.
`topics.resultsMessage`	`string`	Message shown to learners after completing the topic.
`topics.passMessage`	`string`	Message shown to learners when they pass the topic's assessment.
`topics.failMessage`	`string`	Message shown to learners when they fail the topic's assessment.
`topics.navigationDisabled`	`boolean`	When `true`, learners cannot freely navigate away from this topic until it is completed.
`topics.instructorAssessment`	`boolean`	When `true`, the topic requires manual grading by an instructor.
`topics.questionSkipEnabled`	`boolean`	When `true`, learners are allowed to skip individual questions within the topic.
`topics.isProctored`	`boolean`	When `true`, the topic is delivered under proctored exam conditions.
`topics.allowToResume`	`boolean`	When `true`, learners can resume the topic from where they left off after exiting.
`topics.assetType`	`string`	The media or content asset type associated with the topic (e.g., video, SCORM, PDF).