academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Module-reports [Beta] → List module reports

AI-generated

Summary

Lists academyFIVE module reports, with optional pagination, filters, sorting, and included related resources.

Inputs

  • current-site-id (required) — Site ID to use as the report context.
  • page[number] — Page to retrieve, starting at 1; defaults to 1.
  • page[size] — Number of results per page; defaults to 50.
  • filter[ids] — Comma-separated module IDs to include.
  • filter[isActive] — Filter by status: 1 for active or 0 for inactive.
  • filter[labelOrCode] — Filter by module name or code; % is a wildcard.
  • filter[areaIds] — Comma-separated subject area IDs to filter by.
  • filter[studyProgramIds] — Comma-separated study program IDs to filter by.
  • sort — Comma-separated fields to sort by; fields sort ascending by default and a - prefix sorts descending.
  • include — Comma-separated related resources to include, such as areas or studyPrograms.

Output shape

A list of JSON items, one per returned report.

The node passes the API response through as JSON output. Pagination is controlled by the optional page parameters; the source does not establish whether the API response includes pagination metadata.

Links

Discussion