academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Cohorts [Beta] → List cohorts

AI-generated

Summary

List cohorts from the academyFIVE API, optionally filtering, sorting, paginating, and including related resources.

Inputs

  • Additional Fields — Optional parameters to refine the list query, including pagination (page number and size), filtering by IDs, name, site IDs, active status, study program IDs, start date, sorting fields, and inclusion of related resources like working periods.

Output shape

a JSON array of cohort objects with metadata and optionally included related resources as specified.

Supports pagination via page[number] and page[size]. Filters can be applied by IDs, name, site IDs, active status, study programs, and start date. Use the 'include' parameter to embed related data such as working periods. Returned data is in JSON array form suited for further processing in the workflow.

Examples

Example 1: Fetch the first 25 active cohorts related to specific study programs, including their working periods, sorted by start date ascending and name descending.

Set page[number] to 1, page[size] to 25, filter[isActive] to '1', filter[studyProgramIds] to a comma-separated list of IDs, include to 'workingPeriods', and sort to 'startDate,-name'.

Links

Discussion