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

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "string",
  "type": "ad",
  "preTextBlock": "string",
  "postTextBlock": "string",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "resultsMessage": "string",
  "passMessage": "string",
  "failMessage": "string",
  "navigationDisabled": true,
  "questionSkipEnabled": true
}

Response fields

Field	Type	Description
`id`	`uuid`	Unique identifier of the topic.
`title`	`string`	Display title of the topic.
`type`	`TopicType`	The topic's content type (e.g., `ad`, `quiz`, `video`).
`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.
`questionSkipEnabled`	`boolean`	When `true`, learners may skip individual questions within the topic.