ENenphase
System Details

Retrieves a System by id

Retrieves a System by ID

get/api/v4/systems/{system_id}

Request

Path parameters

system_idinteger required

The unique numeric ID of the system. If an empty value is passed in the ID, this endpoint behaves as Fetch systems endpoint.

Response

System fetched

system_idinteger

The unique numeric ID of the system

namestring

Name of the system

public_namestring

Name displayed on the public system page. Available values are All, Residential System, Commercial etc. Default='Residential System'. Only for systems that allow public access.

timezonestring

Timezone to which the system belongs

connection_typestring

Connection Type of the system. Available values are ethernet, Wi-Fi, Cellular

energy_lifetimeinteger

Deprecated field. The API will always return this field as -1

energy_todayinteger

Deprecated field. The API will always return this field as -1

system_sizenumber float

Deprecated field. The API will always return this field as -1

statusstring

System's status. Corresponding Enlighten values can be found in table added at the end of page.

stageinteger

Current stage of the system. Stage values indicate the system's progression through the activation process.

last_report_atinteger

Timestamp (in epoch format) at which the system's Envoy last submitted a report

last_energy_atinteger

Timestamp (in epoch format) at which the systems's produced energy was last reported. Even if the last produced energy is 0, its timestamp will be returned.

operational_atinteger

Timestamp (in epoch format) at which this system became operational. Corresponds to the system’s interconnect time, if one is specified. Otherwise, it is the system’s first reported interval end time.

attachment_typestring

Micro inverter attachment type. Available values are rack_mount, zep, acm, bipv, frame_mount, railless_mount

interconnect_dateinteger

Date on which the system was approved to connect to the grid

referencestring

If the calling user belongs to a company and that company has provided its own identifier for a system, that ID is included here. Otherwise, this attribute is not returned.

other_referencesstring[]

If any other companies have provided their own identifiers for a system, those identifiers are included here. Otherwise, this attribute is not returned.

Changes

No recorded changes to this operation across all 2 revisions of this API.