Skip to main content
GET
/
modules
List Modules
curl --request GET \
  --url https://api.example.com/modules

​
GET /modules

Returns all PV modules belonging to the authenticated workspace. Use this to populate equipment selection dropdowns or to audit the module library before running an energy model.

​
Notes

  • Requires a valid JWT with read access to the workspace.
  • Returns an array of ModuleResponse objects, each containing the module’s parsed properties and optional AOI curve data.
  • Modules are workspace-scoped; you will only see modules created within the current workspace.
  • To retrieve a single module by ID, use GET /modules/{module_id}.
  • To add modules, use POST /modules (file upload) or POST /modules/json (JSON body).