academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Modules [Beta] → Get module by id

AI-generated

Summary

Retrieve detailed information about a specific module by its unique moduleId, optionally including related resources or specifying the current active site.

Inputs

  • moduleId (required) — Unique identifier of the module to fetch (e.g., '42'). Passed as a path parameter in the API request.
  • Additional Fields — Optional parameters for the request, including:
  • current-site-id: Numeric ID of the currently active site, used to verify if the modules feature is enabled for that site.
  • include: Comma-separated list of related resources to include in the response, such as 'areas' to fetch subject areas linked to the module.

Output shape

a JSON object representing the requested module data, optionally enriched with related resources as specified. Includes HTTP headers and status if the response is binary; otherwise, returns the parsed JSON body.

The operation performs an HTTP GET request to '/api/v1/modules/{moduleId}', substituting the moduleId in the URL path. Additional fields are sent as query parameters. If the response is binary, the node outputs the data as binary alongside metadata such as mimeType, fileName, headers, and statusCode. For non-binary JSON responses, it outputs the JSON array parsed from the response, paired with the input item index. Errors propagate unless the node is set to continue on fail, in which case error details are returned in the output.

Links

Discussion