academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Study-programs [Beta] → List study programs

AI-generated

Summary

List study programs with optional pagination, filtering, sorting, and related resource inclusion to retrieve detailed data from the academyFIVE API.

Inputs

  • page[number] — Specify the page number for paginated results, starting at 1 (default is 1).
  • page[size] — Set the number of results per page, defaulting to 50.
  • sort — Define the sort order by id, abbreviation, name, nameDe, nameEn, categoryLabel, degreeLevelLabel, or studyFormLabel.
  • include — List related resources to include, e.g., 'studyProgramStatistics' to retrieve cohort and student count statistics.
  • filter[status] — Filter study programs by status with options: active, inactive, activeOrUpcoming (not yet expired), or all (default).
  • filter[searchTerm] — Filter programs matching a search term in abbreviation, German, or English names (case-insensitive partial match).
  • filter[categoryId] — Filter by numeric study program category ID.
  • filter[degreeLevelId] — Filter by comma-separated list of degree level ULIDs.
  • filter[studyForm] — Filter by study form type, e.g., fulltime or parttime.
  • filter[notReportable] — Filter by whether the program is continuing education or preliminary studies for German higher-education statistics. Allowed values: true, false, 1, 0.
  • filter[locationIds] — Filter by comma-separated list of location/site IDs.

Output shape

a JSON array of study program objects, optionally including related resources like studyProgramStatistics if requested.

Supports standard pagination via page[number] and page[size]. Additional filters customize results. Included related resources are returned under a top-level 'included' array. Response is JSON unless binary response is specifically defined (not applicable here). Errors returned per item if 'Continue On Fail' is enabled.

Examples

Example 1: Retrieve the first page of active study programs sorted by name with statistics included.

Set 'filter[status]' to 'active', 'sort' to 'name', and 'include' to 'studyProgramStatistics'. Use defaults for pagination.

Links

Discussion