Skip to content
Docs
English
EnglishDeutschNot translatedEspañolNot translated
Esc
↑↓navigate↵open⌘Jpreview

Get a module version

Returns the requested module version fully expanded: examination requirements, time plan, files, course connections, and the parent module with all sibling versions. Scoped to your integration’s institution via Basic Auth credentials.

GET/modules/{id}/versions/{versionId}
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters
idstringrequired
versionIdstringrequired
Responses
200

Version detail

dataModuleVersionWithModulerequired

Module version from GET /modules/{id}/versions/{versionId}, including nested parent module with all sibling versions.

Show properties
idstring
versionstring
namestring
descriptionstring | null
iconstring | null
iconTypestring | null
bannerstring | null
createdAtstring<date-time>
updatedAtstring<date-time>
requiredAttendancePercentageinteger
ectsPointsinteger
courseModuleIdstring
statusstring
timePlanIdstring | null
isDefaultboolean
earlyAssessmentEnabledboolean
isCurrentlyElectableboolean
capacityinteger | null
colorinteger | null
courseChatFileAttachmentsDefaultboolean
courseChatReadOnlyDefaultboolean
courseFeatureDefaultsobject | null
moduleNamestring | null
attemptRulesobject | null
createdCoursesobject[]

rows created from this version.

timePlanInstitutionLessonUnit | null

relation.

Show properties
One of:
InstitutionLessonUnit
idstringrequired
namestringrequired
institutionIdstringrequired
minutesintegerrequired
isDefaultbooleanrequired
null
null
parentConnectionsobject[]

Nested childModuleVersion is the full

childConnectionsobject[]

Nested parentModuleVersion is the full

examinationRequirementsModuleVersionExaminationRequirement[]

Examination requirement with template defaults applied.

Show properties
Array of ModuleVersionExaminationRequirement
idstringrequired
courseModuleVersionIdstring
namestringrequired
nameEnglishstring | null
typestringrequired
lengthinteger | null
ratingModestring
schedulingModestring
isFinalExamboolean
weightPercentageinteger | null
attemptWorkflowstring
examinationRequirementTemplateIdstring | null
templateIdstring | null

Alias of examinationRequirementTemplateId after merge.

allowAlternativeRequestboolean
needsTopicConfirmationboolean
topicSubmissionDaysBeforeDeadlineinteger | null
examineeAssignmentModestring
customExamFormIdstring | null
nameTranslationsobject | null
examinationRequirementTemplateobject | null
timePlanItemsModuleVersionTimePlanItem[]

Time plan item (id, name, needsAppointment, amount).

Show properties
Array of ModuleVersionTimePlanItem
idstringrequired
namestringrequired
needsAppointmentbooleanrequired
amountintegerrequired
additionalDescriptionsModuleVersionAdditionalDescription[]

Additional description blocks, sorted by position.

Show properties
Array of ModuleVersionAdditionalDescription
idstringrequired
namestringrequired
descriptionstring | null
positionintegerrequired
courseModuleModuleInVersionDetail

Parent module on GET /modules/{id}/versions/{versionId}, including all sibling versions (fully expanded).

Show properties
idstringrequired
namestringrequired
institutionIdstringrequired
codestring | null
isArchivedboolean | null
nameTranslationsobject | null
courseModuleTagsModuleTag[]required
Show properties
Array of ModuleTag
idstringrequired
courseModuleIdstringrequired
tagIdstringrequired
tagobjectrequired
Show properties
idstringrequired
namestringrequired
institutionIdstringrequired
colorstring | null
iconstring | null
versionsModuleVersionDetail[]required

All sibling versions, each fully expanded (same shape as the top-level version, without nested parent module).

Show properties
Array of ModuleVersionDetail
idstring
versionstring
namestring
descriptionstring | null
iconstring | null
iconTypestring | null
bannerstring | null
createdAtstring<date-time>
updatedAtstring<date-time>
requiredAttendancePercentageinteger
ectsPointsinteger
courseModuleIdstring
statusstring
timePlanIdstring | null
isDefaultboolean
earlyAssessmentEnabledboolean
isCurrentlyElectableboolean
capacityinteger | null
colorinteger | null
courseChatFileAttachmentsDefaultboolean
courseChatReadOnlyDefaultboolean
courseFeatureDefaultsobject | null
moduleNamestring | null
attemptRulesobject | null
createdCoursesobject[]

rows created from this version.

timePlanInstitutionLessonUnit | null

relation.

Show properties
One of:
InstitutionLessonUnit
InstitutionLessonUnit
null
null
parentConnectionsobject[]

Nested childModuleVersion is the full

childConnectionsobject[]

Nested parentModuleVersion is the full

examinationRequirementsModuleVersionExaminationRequirement[]

Examination requirement with template defaults applied.

timePlanItemsModuleVersionTimePlanItem[]

Time plan item (id, name, needsAppointment, amount).

additionalDescriptionsModuleVersionAdditionalDescription[]

Additional description blocks, sorted by position.

filesModuleVersionFile[]

Files attached to this version (id, fileUrl).

filesModuleVersionFile[]

Files attached to this version (id, fileUrl).

Show properties
Array of ModuleVersionFile
idstringrequired
fileUrlstringrequired
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
401

Unauthorized

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
404

Not Found

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
422

Unprocessable Entity — validation or business rule error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
429

Too Many Requests

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
500

Internal Server Error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://fuxam.app/api/v4/modules/string/versions/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'
Response
{
  "data": {
    "id": "cmv_abc123",
    "version": "1.0.0",
    "name": "Introduction to Economics",
    "description": "Introductory economics module.",
    "icon": "📚",
    "iconType": "emoji",
    "banner": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-06-01T08:30:00.000Z",
    "requiredAttendancePercentage": 80,
    "ectsPoints": 5,
    "courseModuleId": "cm_xyz789",
    "status": "ACTIVE",
    "timePlanId": "ilu_001",
    "isDefault": true,
    "earlyAssessmentEnabled": false,
    "isCurrentlyElectable": true,
    "capacity": 30,
    "color": null,
    "courseChatFileAttachmentsDefault": true,
    "courseChatReadOnlyDefault": false,
    "courseFeatureDefaults": null,
    "moduleName": "Economics 101",
    "attemptRules": null,
    "createdCourses": [
      {
        "id": "course_001",
        "layer_id": "layer_001",
        "name": "Introduction to Economics",
        "icon": "/illustrations/course-icon-library/book-worm.webp",
        "color": 5,
        "dynamicBanner": null,
        "institution_id": "inst_123",
        "description": null,
        "bannerImage": null,
        "iconType": "image",
        "courseModuleVersionId": "cmv_abc123",
        "curriculaId": null,
        "code": "ECO-101",
        "capacity": null,
        "status": "ACTIVE",
        "isDatabase": false,
        "settings": null,
        "learningJourneyMode": "DEFAULT",
        "scormFileUrl": null,
        "scormR2FileUrl": null,
        "scormProcessingProgress": null,
        "scormProcessingStage": null,
        "scormProcessingStatus": null
      }
    ],
    "timePlan": {
      "id": "ilu_001",
      "name": "UE",
      "institutionId": "inst_123",
      "minutes": 45,
      "isDefault": false
    },
    "parentConnections": [
      {
        "id": "conn_002",
        "parentModuleVersionId": "cmv_abc123",
        "childModuleVersionId": "cmv_child",
        "studyPeriodId": "cvt_001",
        "childModuleVersion": {
          "id": "cmv_child",
          "version": "2.0.0",
          "name": "Follow-up Module",
          "description": null,
          "icon": null,
          "iconType": "emoji",
          "banner": null,
          "createdAt": "2026-01-15T10:00:00.000Z",
          "updatedAt": "2026-06-01T08:30:00.000Z",
          "requiredAttendancePercentage": 80,
          "ectsPoints": 5,
          "courseModuleId": "cm_followup",
          "status": "ACTIVE",
          "timePlanId": null,
          "isDefault": false,
          "earlyAssessmentEnabled": false,
          "isCurrentlyElectable": true,
          "capacity": null,
          "color": null,
          "courseChatFileAttachmentsDefault": true,
          "courseChatReadOnlyDefault": false,
          "courseFeatureDefaults": null,
          "moduleName": null,
          "attemptRules": null
        }
      }
    ],
    "childConnections": [
      {
        "id": "conn_001",
        "parentModuleVersionId": "cmv_parent",
        "childModuleVersionId": "cmv_abc123",
        "studyPeriodId": "cvt_001",
        "parentModuleVersion": {
          "id": "cmv_parent",
          "version": "1.0.0",
          "name": "Prerequisite Module",
          "description": null,
          "icon": null,
          "iconType": "emoji",
          "banner": null,
          "createdAt": "2026-01-01T10:00:00.000Z",
          "updatedAt": "2026-06-01T08:30:00.000Z",
          "requiredAttendancePercentage": 80,
          "ectsPoints": 5,
          "courseModuleId": "cm_prereq",
          "status": "ACTIVE",
          "timePlanId": null,
          "isDefault": true,
          "earlyAssessmentEnabled": false,
          "isCurrentlyElectable": true,
          "capacity": null,
          "color": null,
          "courseChatFileAttachmentsDefault": true,
          "courseChatReadOnlyDefault": false,
          "courseFeatureDefaults": null,
          "moduleName": null,
          "attemptRules": null
        }
      }
    ],
    "examinationRequirements": [
      {
        "id": "req_001",
        "courseModuleVersionId": "cmv_abc123",
        "name": "Final Exam",
        "nameEnglish": null,
        "type": "exam",
        "length": 120,
        "ratingMode": "PASSED_OR_FAILED",
        "schedulingMode": "DEADLINE",
        "isFinalExam": true,
        "weightPercentage": 100,
        "attemptWorkflow": "AUTO_REATTEMPT",
        "examinationRequirementTemplateId": "ert_001",
        "templateId": "ert_001",
        "allowAlternativeRequest": false,
        "needsTopicConfirmation": false,
        "topicSubmissionDaysBeforeDeadline": null,
        "examineeAssignmentMode": "STANDARD",
        "customExamFormId": null,
        "nameTranslations": null,
        "examinationRequirementTemplate": null
      }
    ],
    "timePlanItems": [
      {
        "id": "tpi_001",
        "name": "Lecture",
        "needsAppointment": true,
        "amount": 14
      }
    ],
    "additionalDescriptions": [
      {
        "id": "desc_001",
        "name": "Learning Outcomes",
        "description": "Students will understand basic economics.",
        "position": 0
      }
    ],
    "courseModule": {
      "id": "cm_xyz789",
      "name": "Economics",
      "institutionId": "inst_123",
      "code": "ECO-101",
      "isArchived": false,
      "nameTranslations": null,
      "courseModuleTags": [
        {
          "id": "cmt_abc123",
          "courseModuleId": "cm_xyz789",
          "tagId": "tag_def456",
          "tag": {
            "id": "tag_def456",
            "name": "Core Module",
            "institutionId": "inst_123",
            "color": "#0361fc",
            "icon": "book"
          }
        }
      ],
      "versions": [
        {
          "id": "cmv_abc123",
          "version": "1.0.0",
          "name": "Introduction to Economics",
          "description": "Introductory economics module.",
          "icon": "📚",
          "iconType": "emoji",
          "banner": null,
          "createdAt": "2026-01-15T10:00:00.000Z",
          "updatedAt": "2026-06-01T08:30:00.000Z",
          "requiredAttendancePercentage": 80,
          "ectsPoints": 5,
          "courseModuleId": "cm_xyz789",
          "status": "ACTIVE",
          "timePlanId": "ilu_001",
          "isDefault": true,
          "earlyAssessmentEnabled": false,
          "isCurrentlyElectable": true,
          "capacity": 30,
          "color": null,
          "courseChatFileAttachmentsDefault": true,
          "courseChatReadOnlyDefault": false,
          "courseFeatureDefaults": null,
          "moduleName": "Economics 101",
          "attemptRules": null,
          "createdCourses": [
            {
              "id": "course_001",
              "layer_id": "layer_001",
              "name": "Introduction to Economics",
              "icon": "/illustrations/course-icon-library/book-worm.webp",
              "color": 5,
              "dynamicBanner": null,
              "institution_id": "inst_123",
              "description": null,
              "bannerImage": null,
              "iconType": "image",
              "courseModuleVersionId": "cmv_abc123",
              "curriculaId": null,
              "code": "ECO-101",
              "capacity": null,
              "status": "ACTIVE",
              "isDatabase": false,
              "settings": null,
              "learningJourneyMode": "DEFAULT",
              "scormFileUrl": null,
              "scormR2FileUrl": null,
              "scormProcessingProgress": null,
              "scormProcessingStage": null,
              "scormProcessingStatus": null
            }
          ],
          "timePlan": {
            "id": "ilu_001",
            "name": "UE",
            "institutionId": "inst_123",
            "minutes": 45,
            "isDefault": false
          },
          "parentConnections": [
            {
              "id": "conn_002",
              "parentModuleVersionId": "cmv_abc123",
              "childModuleVersionId": "cmv_child",
              "studyPeriodId": "cvt_001",
              "childModuleVersion": {
                "id": "cmv_child",
                "version": "2.0.0",
                "name": "Follow-up Module",
                "description": null,
                "icon": null,
                "iconType": "emoji",
                "banner": null,
                "createdAt": "2026-01-15T10:00:00.000Z",
                "updatedAt": "2026-06-01T08:30:00.000Z",
                "requiredAttendancePercentage": 80,
                "ectsPoints": 5,
                "courseModuleId": "cm_followup",
                "status": "ACTIVE",
                "timePlanId": null,
                "isDefault": false,
                "earlyAssessmentEnabled": false,
                "isCurrentlyElectable": true,
                "capacity": null,
                "color": null,
                "courseChatFileAttachmentsDefault": true,
                "courseChatReadOnlyDefault": false,
                "courseFeatureDefaults": null,
                "moduleName": null,
                "attemptRules": null
              }
            }
          ],
          "childConnections": [
            {
              "id": "conn_001",
              "parentModuleVersionId": "cmv_parent",
              "childModuleVersionId": "cmv_abc123",
              "studyPeriodId": "cvt_001",
              "parentModuleVersion": {
                "id": "cmv_parent",
                "version": "1.0.0",
                "name": "Prerequisite Module",
                "description": null,
                "icon": null,
                "iconType": "emoji",
                "banner": null,
                "createdAt": "2026-01-01T10:00:00.000Z",
                "updatedAt": "2026-06-01T08:30:00.000Z",
                "requiredAttendancePercentage": 80,
                "ectsPoints": 5,
                "courseModuleId": "cm_prereq",
                "status": "ACTIVE",
                "timePlanId": null,
                "isDefault": true,
                "earlyAssessmentEnabled": false,
                "isCurrentlyElectable": true,
                "capacity": null,
                "color": null,
                "courseChatFileAttachmentsDefault": true,
                "courseChatReadOnlyDefault": false,
                "courseFeatureDefaults": null,
                "moduleName": null,
                "attemptRules": null
              }
            }
          ],
          "examinationRequirements": [
            {
              "id": "req_001",
              "courseModuleVersionId": "cmv_abc123",
              "name": "Final Exam",
              "nameEnglish": null,
              "type": "exam",
              "length": 120,
              "ratingMode": "PASSED_OR_FAILED",
              "schedulingMode": "DEADLINE",
              "isFinalExam": true,
              "weightPercentage": 100,
              "attemptWorkflow": "AUTO_REATTEMPT",
              "examinationRequirementTemplateId": "ert_001",
              "templateId": "ert_001",
              "allowAlternativeRequest": false,
              "needsTopicConfirmation": false,
              "topicSubmissionDaysBeforeDeadline": null,
              "examineeAssignmentMode": "STANDARD",
              "customExamFormId": null,
              "nameTranslations": null,
              "examinationRequirementTemplate": null
            }
          ],
          "timePlanItems": [
            {
              "id": "tpi_001",
              "name": "Lecture",
              "needsAppointment": true,
              "amount": 14
            }
          ],
          "additionalDescriptions": [
            {
              "id": "desc_001",
              "name": "Learning Outcomes",
              "description": "Students will understand basic economics.",
              "position": 0
            }
          ],
          "files": [
            {
              "id": "file_001",
              "fileUrl": "https://storage.example.com/module.pdf"
            }
          ]
        }
      ]
    },
    "files": [
      {
        "id": "file_001",
        "fileUrl": "https://storage.example.com/module.pdf"
      }
    ]
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}