Saltar al contenido
Docs
Español
EnglishDeutschSin traducirEspañolSin traducir
Esc
↑↓navegar↵abrir⌘Jvista previa

Get a curriculum

Returns a curriculum with version summaries and module items (planning units included). For full term, pathway, and cluster detail on one version, use GET /curricula/{id}/versions/{versionId}. Scoped to your integration’s institution via Basic Auth credentials.

GET/curricula/{id}
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters
idstringrequired
Responses
200

Curriculum detail

dataCurriculaDetailrequired

Curriculum with version summaries and module items. Use GET /curricula/{id}/versions/{versionId} for full term, pathway, and cluster detail.

Show properties
idstringrequired
namestringrequired
codestring | nullrequired
isCohortSpecificbooleanrequired

Whether this curriculum is tied to a specific cohort.

institutionIdstringrequired
versionsCurriculaVersionInCurriculumDetail[]required

Version summaries (subset of the full version detail; omits some metadata such as election settings).

Show properties
Array of CurriculaVersionInCurriculumDetail
idstringrequired
namestringrequired
versionstringrequired
isDefaultbooleanrequired
isCohortVersionbooleanrequired
sourceCohortobject | null
Show properties
idstring
namestring
curriculaobjectrequired

Parent curriculum summary (includes institutionId; omitted on GET /versions/{versionId}).

Show properties
idstringrequired
namestringrequired
isCohortSpecificbooleanrequired
institutionIdstringrequired
curriculaVersionModuleClusterobject[]required
curriculaVersionPathwaysCurriculaVersionPathway[]required
Show properties
Array of CurriculaVersionPathway
idstringrequired
positionintegerrequired
namestringrequired
typestringrequired

FIXED = mandatory pathway; SELECTABLE_FOCUS = student chooses one focus.

Allowed:FIXEDSELECTABLE_FOCUS
curriculaVersionIdstringrequired
descriptionstring | null
curriculaVersionTermsCurriculaVersionTermInDetail[]required
Show properties
Array of CurriculaVersionTermInDetail
idstringrequired
positionintegerrequired
namestringrequired
curriculaVersionIdstringrequired
cohortCurriculaVersionTermCohortCurriculaVersionTermInDetail[]required
Show properties
Array of CohortCurriculaVersionTermInDetail
idstringrequired
curriculaVersionTermIdstringrequired
organizationTermIdstringrequired
cohortIdstringrequired
institutionIdstringrequired
cohortobjectrequired
Show properties
idstringrequired
namestringrequired
organizationTermOrganizationTermrequired

Academic term (semester) with optional module election and reassessment registration windows.

Show properties
idstringrequired
namestringrequired
termEndstring<date-time>required

End of the academic term.

institutionIdstringrequired
termStartstring<date-time>required

Start of the academic term.

codestring | null
electionEndstring<date-time> | null

Deadline for module elections for this term.

electionStartstring<date-time> | null

When students may begin electing modules for this term.

reassessmentRegistrationEndstring<date-time> | null

When reassessment registration closes.

reassessmentRegistrationStartstring<date-time> | null

When reassessment registration opens.

curriculaVersionTermCurriculaVersionTermrequired
Show properties
idstringrequired
positionintegerrequired
namestringrequired
curriculaVersionIdstringrequired
cohortStudyTimelineStatusobject | null
curriculaVersionItemsCurriculaVersionItemDetail[]required
Show properties
Array of CurriculaVersionItemDetail
idstringrequired
curriculaVersionIdstringrequired
courseModuleIdstringrequired
courseModuleVersionIdstring | null
curriculaVersionTermIdstring | null
curriculaVersionModuleClusterIdstring | null
curriculaVersionPathwayIdstring | null
parentIdstring | null
updatedAtstring<date-time>required
isCoreModulebooleanrequired
courseModuleobject | null

with nested courseModuleTags.

Show properties
idstring
namestring
institutionIdstring
codestring | null
isArchivedboolean | null
nameTranslationsobject | null
courseModuleTagsModuleTag[]
Show properties
Array of ModuleTag
idstringrequired
courseModuleIdstringrequired
tagIdstringrequired
tagobjectrequired
Show properties
idstringrequired
namestringrequired
institutionIdstringrequired
colorstring | null
iconstring | null
curriculaVersionTermCurriculaVersionTermInDetail | null
Show properties
One of:
CurriculaVersionTermInDetail
CurriculaVersionTermInDetail
null
null
curriculaVersionPathwayCurriculaVersionPathway | null
Show properties
One of:
CurriculaVersionPathway
CurriculaVersionPathway
null
null
curriculaVersionModuleClusterobject | null
moduleGroupIdstring | nullrequired
moduleGroupobject | nullrequired
Show properties
idstring
namestring
codestring | null
colorstring | null
courseModuleVersionCurriculaVersionItemModuleVersion | null
Show properties
One of:
CurriculaVersionItemModuleVersion
examinationRequirementsobject[]required
courseModuleIdstringrequired
idstringrequired
parentConnectionsobject[]required

Nested childModuleVersion is the full

childConnectionsobject[]required

Nested parentModuleVersion may include the parent module.

namestringrequired
moduleNamestring | null
versionstringrequired
ectsPointsintegerrequired
unitAmountnumberrequired

Total scheduled units from time plan items that require appointments.

unitNamestringrequired

Lesson unit name (from the version time plan or institution default).

unitMinuteEquivalentnumberrequired

Lesson unit length in minutes (from the version time plan or institution default).

null
null
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/curricula/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'
Response
{
  "data": {
    "id": "cur_001",
    "name": "Bachelor CS 2024",
    "code": "CS-2024",
    "isCohortSpecific": false,
    "institutionId": "inst_123",
    "versions": [
      {
        "id": "cv_001",
        "name": "Default",
        "version": "1.0",
        "isDefault": true,
        "isCohortVersion": false,
        "sourceCohort": null,
        "curricula": {
          "id": "cur_001",
          "name": "Bachelor CS 2024",
          "isCohortSpecific": false,
          "institutionId": "inst_123"
        },
        "curriculaVersionModuleCluster": [
          {
            "id": "cvmc_001",
            "electiveBehavior": "SELECT_UNTIL_ECTS",
            "electiveBehaviorAmount": 30,
            "rule": null,
            "ruleAmount": null,
            "createdAt": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-06-01T00:00:00.000Z",
            "curriculaVersionId": "cv_001",
            "name": "Elective Pool",
            "unlockAfterCP": null,
            "electAtOnce": false,
            "overflowClusterId": null,
            "isReElectable": false
          }
        ],
        "curriculaVersionPathways": [
          {
            "id": "path_001",
            "position": 0,
            "name": "Software Engineering",
            "type": "SELECTABLE_FOCUS",
            "curriculaVersionId": "cv_001",
            "description": "Focus on software development."
          }
        ],
        "curriculaVersionTerms": [
          {
            "id": "cvt_001",
            "position": 0,
            "name": "Semester 1",
            "curriculaVersionId": "cv_001",
            "cohortCurriculaVersionTerm": []
          }
        ],
        "curriculaVersionItems": [
          {
            "id": "cvi_001",
            "curriculaVersionId": "cv_001",
            "courseModuleId": "cm_xyz789",
            "courseModuleVersionId": "cmv_abc123",
            "curriculaVersionTermId": "cvt_001",
            "curriculaVersionModuleClusterId": null,
            "curriculaVersionPathwayId": "path_001",
            "parentId": null,
            "updatedAt": "2026-06-01T00:00:00.000Z",
            "isCoreModule": true,
            "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"
                  }
                }
              ]
            },
            "curriculaVersionTerm": {
              "id": "cvt_001",
              "position": 0,
              "name": "Semester 1",
              "curriculaVersionId": "cv_001",
              "cohortCurriculaVersionTerm": [
                {
                  "id": "ccvt_001",
                  "curriculaVersionTermId": "cvt_001",
                  "organizationTermId": "ot_001",
                  "cohortId": "coh_001",
                  "institutionId": "inst_123",
                  "cohort": {
                    "id": "coh_001",
                    "name": "WS 2024/25"
                  },
                  "organizationTerm": {
                    "id": "ot_001",
                    "name": "WS 2024/25",
                    "termEnd": "2025-03-31T23:59:59.000Z",
                    "institutionId": "inst_123",
                    "termStart": "2024-10-01T00:00:00.000Z",
                    "code": "WS24",
                    "electionEnd": null,
                    "electionStart": null,
                    "reassessmentRegistrationEnd": null,
                    "reassessmentRegistrationStart": null
                  },
                  "curriculaVersionTerm": {
                    "id": "cvt_001",
                    "position": 0,
                    "name": "Semester 1",
                    "curriculaVersionId": "cv_001"
                  },
                  "cohortStudyTimelineStatus": null
                }
              ]
            },
            "curriculaVersionPathway": {
              "id": "path_001",
              "position": 0,
              "name": "Software Engineering",
              "type": "SELECTABLE_FOCUS",
              "curriculaVersionId": "cv_001",
              "description": "Focus on software development."
            },
            "curriculaVersionModuleCluster": null,
            "moduleGroupId": null,
            "moduleGroup": null,
            "courseModuleVersion": {
              "examinationRequirements": [],
              "courseModuleId": "cm_xyz789",
              "id": "cmv_abc123",
              "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,
                    "courseModule": {
                      "id": "cm_prereq",
                      "name": "Prerequisite Module",
                      "institutionId": "inst_123",
                      "code": "PRE-101",
                      "isArchived": false,
                      "nameTranslations": null
                    }
                  }
                }
              ],
              "name": "Introduction to Economics",
              "moduleName": "Economics 101",
              "version": "1.0.0",
              "ectsPoints": 5,
              "unitAmount": 14,
              "unitName": "UE",
              "unitMinuteEquivalent": 45
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}