Topics

Returns a single topic by its unique identifier

Returns a single topic by its unique identifier.

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

Example request

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

Parameters

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

Example response

{
  "data": {
    "APITopicById": {
      "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
`id`	`uuid`	Unique identifier of the topic.
`originalId`	`uuid`	Identifier of the original topic this record was derived from, such as after a copy or import.
`title`	`string`	Display title of the topic.
`type`	`TopicType`	The topic's content type (e.g., `ad`, `quiz`, `video`).
`quizQuestions`	`uuid[]`	Ordered list of question IDs associated with this topic.
`preTextBlock`	`string`	HTML or plain-text content displayed to the learner before the topic begins.
`postTextBlock`	`string`	HTML or plain-text content displayed to the learner after the topic ends.
`updatedAt`	`ISO 8601 timestamp`	Date and time the topic was last modified, in ISO 8601 format.
`resultsMessage`	`string`	Message shown to the learner on the results screen after completing the topic.
`passMessage`	`string`	Message shown to the learner when they pass the topic.
`failMessage`	`string`	Message shown to the learner when they fail the topic.
`navigationDisabled`	`boolean`	When `true`, learners cannot skip ahead or navigate freely within the topic.
`instructorAssessment`	`boolean`	When `true`, the topic requires manual grading by an instructor.
`questionSkipEnabled`	`boolean`	When `true`, learners may skip individual questions within the topic.
`isProctored`	`boolean`	When `true`, the topic is delivered under proctored exam conditions.
`allowToResume`	`boolean`	When `true`, learners can exit and resume the topic from where they left off.
`assetType`	`string`	The MIME type or asset category of the topic's primary content file.