academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Modules [Beta] → List modules

AI-generated

Summary

Lists academyFIVE modules, with optional filters, pagination, sorting, and related subject-area data. The node sends the configured values as query parameters and returns the API response as JSON items.

Inputs

  • current-site-id — Active site ID, used by the API to verify that modules are enabled for the site.
  • page[number] — Page to fetch; the declared default is 1.
  • page[size] — Number of results per page; the declared default is 50.
  • filter[ids] — Comma-separated module IDs to include.
  • filter[isActive] — Filter by active status: 1 for active modules or 0 for inactive.
  • filter[labelOrCode] — Filter by module label or code; supports wildcard matching with %.
  • filter[areaIds] — Comma-separated subject area IDs to filter modules by.
  • sort — Comma-separated sort fields (id, isActive, code, labelDe, labelEn); prefix a field with - for descending order.
  • include — Comma-separated related resources to include, such as areas.

Output shape

A list of JSON items from the API response.

The node converts the response with n8n's returnJsonArray helper and pairs returned items with their input item. Pagination is controlled by the optional page parameters.

Links

Discussion