Get inverter overview list
Inverter Overview
Returns a list of all available Inverters however with simplified data properties.
Overview
This endpoint provides a lightweight version of the full inverter list, returning essential inverter information without the complete technical specifications and detailed configuration data. It’s optimized for scenarios where you need a quick overview of available inverters without the overhead of fetching complete inverter records.
Response Fields
The simplified response includes the following fields for each inverter:
| Field | Type | Description |
|---|---|---|
id | integer | Unique identifier for the inverter |
ownerId | integer | ID of the user or organization that owns this inverter configuration |
name | string | Display name for the inverter |
status | integer | Current status of the inverter record (1=Draft, 2=In Review, 3=Active, 4=Archived) |
lastModified | string (ISO 8601) | Timestamp of the last modification to this inverter record |
lastModifiedBy | object | User who last modified the record |
lastModifiedBy.firstName | string | First name of the user who last modified the record |
lastModifiedBy.lastName | string | Last name of the user who last modified the record |
model | string | Manufacturer’s model number/name for the inverter |
manufacturer | string | Name of the inverter manufacturer |
powerRated | number | Rated power output of the inverter in kW |
outputVoltage | number | Output voltage of the inverter in volts |
minVoltage | number | Minimum operating voltage in volts |
maxMPPVoltage | number | Maximum Power Point (MPP) voltage in volts |
inverterType | integer | Type classification of the inverter (1=String Inverter, 2=Central Inverter) |
Excluded Fields
Compared to the full inverter endpoint, this simplified overview excludes:
-
Detailed efficiency curves and performance data
-
Complete electrical specifications and ratings
-
Thermal characteristics and derating factors
-
Advanced configuration parameters
-
Certification and compliance documentation
-
Extended metadata and custom fields
Use Cases
When to Use This Endpoint
-
Dashboard displays - Populating dropdown lists or selection menus
-
Quick searches - Finding inverters by name or manufacturer without loading full details
-
List views - Displaying tables of available inverters with basic information
-
Performance optimization - Reducing payload size and response time for overview screens
-
Mobile applications - Minimizing data transfer for bandwidth-constrained environments
When to Use the Full Endpoint
-
Detailed analysis - When you need complete technical specifications for engineering calculations
-
Configuration management - Setting up or modifying inverter parameters in a project
-
Reporting - Generating comprehensive reports that require all inverter data
-
Data export - Extracting complete inverter information for external systems
Authorizations
Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.
Response
Inverter overviews
LibraryStatusEnum
0, 1, 2, 3, 4, 5, 6 ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.
InverterType
0, 1, 2