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	Unique identifier of the course whose topics to list.
`cursor`	`string`	No	query	Opaque pagination cursor returned by a previous response; use to fetch the next page of results.
`perPage`	`integer`	No	query	Number of topics to return per page.

Example response

{
  "pageInfo": {
    "total": 0,
    "cursor": "string",
    "hasMore": true
  },
  "topics": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "type": "ad",
      "preTextBlock": "string",
      "postTextBlock": "string",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Response fields

Field	Type	Description
`pageInfo`	`CursorPageInfo`	Pagination metadata for the current result set.
`pageInfo.total`	`integer`	Total number of topics across all pages.
`pageInfo.cursor`	`string`	Opaque cursor to pass in the next request to retrieve the following page.
`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.title`	`string`	Display title of the topic.
`topics.type`	`TopicType`	Content type of the topic (e.g., `ad`, quiz, video).
`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.