Skip to main content
GET
Get a specific topic

Authorizations

Authorization
string
header
required

Your organisation's API key, sent as Authorization: my_api_key. The key can also be passed as an api_key query parameter. See Authentication.

Path Parameters

id
integer
required

The unique identifier of a topic

Response

The topic

id
integer
title
string
knowledge_code
string
structure
string
assessment
boolean
num_assessment_questions_to_ask
integer
num_assessment_questions_to_pass
integer
num_assessment_resets_permitted
integer
duration_in_minutes
integer
free
boolean
restricted
boolean
due_mode
enum<string>

none, fixed_date (due by due_date) or fixed_time (due due_in_days after enrolment)

Available options:
none,
fixed_date,
fixed_time
due_date
string | null
due_in_days
integer | null
visibility
enum<string>

private (draft), public (active) or archived

Available options:
private,
public,
archived
allow_public_signup
boolean
show_accessibility_section_headers
boolean
show_narration_scripts
boolean
hide_system_oeq_responses
boolean
knowledge_type
enum<integer>

0 = standard topic, 1 = short topic

Available options:
0,
1
manager_enrol
boolean
manager_unenrol
boolean
certified_mode
enum<string>

none (certificate always valid), fixed_date (valid until certified_date) or fixed_time (valid for certified_days)

Available options:
none,
fixed_date,
fixed_time
certified_days
integer | null
certified_date
string | null
show_certificate
boolean
certificate_expire_event
integer

When certified_mode is fixed_time: 0 = days counted from completion, 1 = days counted from enrolment

recertify
boolean
recertification_days
integer
hide_results_until_admin_approval
boolean
created_at
string<date-time>
updated_at
string<date-time>
completion_certificate_id
integer | null
external_id
string | null
categories
object[]
topic_categories
object[]
skills
object[]
saved_searches
object[]
version
object

Current published version. Omitted if the topic has never been published

code
string

Enrolment code for this topic, used in enrolment requests

scorm_file_count
integer