academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Modules [Beta] → List modules

AI-generated

Summary

Lists academyFIVE modules, with optional query parameters to check site access, paginate, filter, sort, and include related subject areas.

Inputs

  • current-site-id — Active site ID used by the API to verify that modules are enabled for that site.
  • page[number] — Page to fetch; the UI description says pagination starts at 1 and defaults to 1.
  • page[size] — Results per page; the UI description says the default is 50.
  • filter[ids] — Comma-separated module IDs to return.
  • filter[isActive] — Filter by active status: 1 for active modules or 0 for inactive modules.
  • 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. Prefix a field with - for descending order. Supported fields: id, isActive, code, labelDe, labelEn.
  • include — Comma-separated related resources to include, such as areas.

Output shape

A list of JSON items, typically one item per returned module.

The node passes configured additional fields as query parameters and converts the API response to n8n JSON items. Pagination is controlled through page[number] and page[size]. With Continue On Fail enabled, a failed request produces an item containing an error message.

Links

Discussion