List study programs
Returns a cursor-paginated list of study programs. Each item includes program versions, responsible users, connected curricula, and summary counts. Use GET /study-programs/{id}/cohorts for cohort details. Scoped to your integration’s institution via Basic Auth credentials.
/study-programsAuthorizationBasic auth · headerrequiredBasic Auth with clientId as username and clientSecret as password
cursorstringlimitintegersearchstringincludeArchivedbooleanWhen false (default), archived study programs are excluded.
List of study programs
dataStudyProgram[]requiredShow propertiesHide properties
StudyProgramidstringrequirednamestringrequiredinstitutionIdstringrequiredobjectivestring | nullisArchivedbooleanrequiredcodestring | nullstatisticDataobject | nulldefaultStudyTimeintegerdefaultTuitionFeePlanIdstring | nullhasCohortsbooleanrequiredhasStatisticsbooleanrequiredtypestring | nullstudyProgramVersionStudyProgramVersion[]requiredProgram versions (cohorts are listed separately).
Show propertiesHide properties
StudyProgramVersionidstringrequirednamestringrequiredinstitutionIdstringrequiredstudyProgramIdstringrequiredisDefaultbooleanrequiredstatisticDataobject | nullresponsibleUsersSimpleUser[]requiredstudyProgramResponsibleUser[].user, sorted by name. The
Show propertiesHide properties
SimpleUseridstringrequirednamestringrequiredemailstring<email>requiredimagestring | nullrequiredconnectedCurriculaStudyProgramConnectedCurricula[]requiredFlattened curricula from studyProgramConnectedCurricula (see StudyProgramConnectedCurricula). The
Show propertiesHide properties
StudyProgramConnectedCurriculaidstringrequirednamestringrequiredinstitutionIdstringrequiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredisCohortSpecificbooleanrequiredisArchivedbooleanrequiredcodestring | nullversionsCountintegerrequiredfirstVersionobjectrequiredThe first program version.
Show propertiesHide properties
idstringrequirednamestringrequiredinstitutionIdstringrequiredstudyProgramIdstringrequiredisDefaultbooleanrequiredstatisticDataobject | nulldefaultVersionStudyProgramVersion | nullThe default program version, if one is set.
Show propertiesHide properties
idstringrequirednamestringrequiredinstitutionIdstringrequiredstudyProgramIdstringrequiredisDefaultbooleanrequiredstatisticDataobject | nullnullversionsCountintegerrequiredTotal number of program versions.
cohortsCountintegerrequiredTotal cohort count across all versions.
studyProgramMetadataobject | nullrequiredAlways null on list and detail responses; use version-specific endpoints for metadata.
paginationCursorPaginationrequiredShow propertiesHide properties
next_cursorstring | nullrequiredhas_morebooleanrequiredlimitintegerrequiredmetaResponseMetarequiredShow propertiesHide properties
requestIdstringrequiredtimestampstring<date-time>requiredversionstringrequiredv4Unauthorized
typestringrequirederrorcodestringrequiredbad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
objectfieldstringmessagestringToo Many Requests
typestringrequirederrorcodestringrequiredbad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
objectfieldstringmessagestringInternal Server Error
typestringrequirederrorcodestringrequiredbad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
objectfieldstringmessagestring