Saltar al contenido
Docs
Español
EnglishDeutschSin traducirEspañolSin traducir
Esc
↑↓navigate↵open⌘Jpreview

Create a cohort for a study program

Creates a cohort linked to a curricula version and study program version. Returns full cohort detail (same shape as GET /study-programs/{id}/cohorts/{cohortId}). studyProgramVersionId defaults to the program’s default version. startDate must be strictly before endDate at minute precision. Cohort dates are compared at minute precision (matching the dashboard). Returns 422 when both fall in the same minute (startDate and endDate must not be in the same minute) or when startDate is after endDate at minute level (startDate must be before endDate). Scoped to your integration’s institution via Basic Auth credentials.

POST/study-programs/{id}/cohorts
Path parameters
idstringrequired
Header parameters
Idempotency-Keystringrequired
Request body
requiredapplication/json
namestringrequired
startDatestring<date-time>required
Cohort start date. Compared at minute precision (seconds are ignored). Must be strictly before `endDate` at minute level. If in the same minute as `endDate`, returns `422` with `startDate and endDate must not be in the same minute`.
endDatestring<date-time>required
Cohort end date. Compared at minute precision (seconds are ignored). Must be strictly after `startDate` at minute level. If in the same minute as `startDate`, returns `422` with `startDate and endDate must not be in the same minute`.
curriculaVersionIdstringrequired
studyProgramVersionIdstring
isArchivedboolean
Responses
201Cohort created
dataCohortDetailrequired
Cohort detail from GET /study-programs/{id}/cohorts/{cohortId}. Includes computed `status`, a sample of members in `users` (up to 5), `totalUsersCount`, and the linked curriculum version structure.
Show properties
idstringrequired
namestringrequired
startDatestring<date-time>required
statusstringrequired
Computed from cohort start and end dates relative to the current date.
Allowed:UPCOMINGACTIVECOMPLETED
endDatestring<date-time>required
curriculaVersionCurriculaVersionDetailrequired
Fully expanded curricula version: terms, pathways, module clusters, module items, and parent curricula metadata.
Show properties
idstringrequired
versionstringrequired
namestringrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
curriculaIdstringrequired
electionEndWeeksinteger | nullrequired
electionModestring | nullrequired
Allowed:ELECT_WHENEVERELECT_BEFORE_TERMELECT_AFTER_TERM
electionStartWeeksinteger | nullrequired
isCohortVersionbooleanrequired
sourceCohortIdstring | nullrequired
sourceCohortobject | nullrequired
Show properties
idstring
namestring
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
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
curriculaVersionModuleClusterobject[]required
Elective module clusters in this version.
isDefaultbooleanrequired
curriculaobjectrequired
Parent curriculum summary (`institutionId` omitted on GET /versions/{versionId}).
Show properties
idstringrequired
namestringrequired
isCohortSpecificbooleanrequired
curriculaVersionItemsCurriculaVersionItemDetail[]required
Module items with planning units.
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 | any
Show properties
One 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
any
any
curriculaVersionPathwayCurriculaVersionPathway | any
Show properties
One of:
CurriculaVersionPathway
idstringrequired
positionintegerrequired
namestringrequired
typestringrequired
FIXED = mandatory pathway; SELECTABLE_FOCUS = student chooses one focus.
Allowed:FIXEDSELECTABLE_FOCUS
curriculaVersionIdstringrequired
descriptionstring | null
any
any
curriculaVersionModuleClusterobject | null
moduleGroupIdstring | nullrequired
moduleGroupobject | nullrequired
Show properties
idstring
namestring
codestring | null
colorstring | null
courseModuleVersionCurriculaVersionItemModuleVersion | any
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).
any
any
curriculaobjectrequired
Show properties
idstringrequired
namestringrequired
isCohortSpecificbooleanrequired
isArchivedbooleanrequired
usersobject[]required
Sample of up to 5 cohort members. Use the members list endpoint for the full list.
Show properties
Array of object
idstringrequired
namestringrequired
emailstring<email>required
imagestring | null
totalUsersCountintegerrequired
Total number of members in the cohort.
hasDisconnectedFromCurriculabooleanrequired
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
400Bad Request
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
401Unauthorized
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
422Unprocessable 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
429Too 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
500Internal 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
Request
curl -X POST "https://fuxam.app/api/v4/study-programs/string/cohorts" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-01T00:00:00Z",
  "curriculaVersionId": "string",
  "studyProgramVersionId": "string",
  "isArchived": true
}'
Response
{
  "data": {
    "id": "coh_001",
    "name": "WS 2024/25",
    "startDate": "2024-10-01T00:00:00.000Z",
    "status": "ACTIVE",
    "endDate": "2027-09-30T00:00:00.000Z",
    "curriculaVersion": {
      "id": "cv_001",
      "version": "1.0",
      "name": "Default",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-06-01T00:00:00.000Z",
      "curriculaId": "cur_001",
      "electionEndWeeks": null,
      "electionMode": null,
      "electionStartWeeks": null,
      "isCohortVersion": false,
      "sourceCohortId": null,
      "sourceCohort": null,
      "curriculaVersionTerms": [
        {
          "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
            }
          ]
        }
      ],
      "curriculaVersionPathways": [
        {
          "id": "path_001",
          "position": 0,
          "name": "Software Engineering",
          "type": "SELECTABLE_FOCUS",
          "curriculaVersionId": "cv_001",
          "description": "Focus on software development."
        }
      ],
      "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
        }
      ],
      "isDefault": true,
      "curricula": {
        "id": "cur_001",
        "name": "Bachelor CS 2024",
        "isCohortSpecific": false
      },
      "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
          }
        }
      ]
    },
    "curricula": {
      "id": "cur_001",
      "name": "Bachelor CS 2024",
      "isCohortSpecific": false
    },
    "isArchived": false,
    "users": [
      {
        "id": "user_abc123",
        "name": "Jane Doe",
        "email": "jane@example.com",
        "image": null
      }
    ],
    "totalUsersCount": 42,
    "hasDisconnectedFromCurricula": false
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}