Get a module
Returns a module with all versions fully expanded (examination requirements, time plan items, files, course connections, tags). Scoped to your integration’s institution via Basic Auth credentials.
GET
/modules/{id}Authorization
AuthorizationBasic auth · headerrequiredBasic Auth with clientId as username and clientSecret as password
Path parameters
idstringrequiredResponses
200
Module
dataModuleDetailrequiredFull module detail with tags and all versions expanded (examination requirements, files, connections).
Show propertiesHide properties
idstringrequirednamestringrequiredinstitutionIdstringrequiredcodestring | nullisArchivedboolean | nullnameTranslationsobject | nullcourseModuleTagsModuleTag[]Show propertiesHide properties
Array of
ModuleTagidstringrequiredcourseModuleIdstringrequiredtagIdstringrequiredtagobjectrequiredShow propertiesHide properties
idstringrequirednamestringrequiredinstitutionIdstringrequiredcolorstring | nulliconstring | nullversionsModuleVersionDetail[]requiredAll versions, each fully expanded with nested relations.
Show propertiesHide properties
Array of
ModuleVersionDetailidstringversionstringnamestringdescriptionstring | nulliconstring | nulliconTypestring | nullbannerstring | nullcreatedAtstring<date-time>updatedAtstring<date-time>requiredAttendancePercentageintegerectsPointsintegercourseModuleIdstringstatusstringtimePlanIdstring | nullisDefaultbooleanearlyAssessmentEnabledbooleanisCurrentlyElectablebooleancapacityinteger | nullcolorinteger | nullcourseChatFileAttachmentsDefaultbooleancourseChatReadOnlyDefaultbooleancourseFeatureDefaultsobject | nullmoduleNamestring | nullattemptRulesobject | nullcreatedCoursesobject[]rows created from this version.
timePlanInstitutionLessonUnit | nullrelation.
Show propertiesHide properties
One of:
InstitutionLessonUnit
idstringrequirednamestringrequiredinstitutionIdstringrequiredminutesintegerrequiredisDefaultbooleanrequirednull
nullparentConnectionsobject[]Nested childModuleVersion is the full
childConnectionsobject[]Nested parentModuleVersion is the full
examinationRequirementsModuleVersionExaminationRequirement[]Examination requirement with template defaults applied.
Show propertiesHide properties
Array of
ModuleVersionExaminationRequirementidstringrequiredcourseModuleVersionIdstringnamestringrequirednameEnglishstring | nulltypestringrequiredlengthinteger | nullratingModestringschedulingModestringisFinalExambooleanweightPercentageinteger | nullattemptWorkflowstringexaminationRequirementTemplateIdstring | nulltemplateIdstring | nullAlias of examinationRequirementTemplateId after merge.
allowAlternativeRequestbooleanneedsTopicConfirmationbooleantopicSubmissionDaysBeforeDeadlineinteger | nullexamineeAssignmentModestringcustomExamFormIdstring | nullnameTranslationsobject | nullexaminationRequirementTemplateobject | nulltimePlanItemsModuleVersionTimePlanItem[]Time plan item (id, name, needsAppointment, amount).
Show propertiesHide properties
Array of
ModuleVersionTimePlanItemidstringrequirednamestringrequiredneedsAppointmentbooleanrequiredamountintegerrequiredadditionalDescriptionsModuleVersionAdditionalDescription[]Additional description blocks, sorted by position.
Show propertiesHide properties
Array of
ModuleVersionAdditionalDescriptionidstringrequirednamestringrequireddescriptionstring | nullpositionintegerrequiredfilesModuleVersionFile[]Files attached to this version (id, fileUrl).
Show propertiesHide properties
Array of
ModuleVersionFileidstringrequiredfileUrlstringrequiredmetaResponseMetarequiredShow propertiesHide properties
requestIdstringrequiredtimestampstring<date-time>requiredversionstringrequiredAllowed:
v4401
Unauthorized
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring404
Not Found
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring422
Unprocessable Entity — validation or business rule error
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring429
Too Many Requests
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring500
Internal Server Error
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring