ENenphase
Activations

Retrieves an Activation by id

By default, the body of the response looks like the example below. However, you can choose to retrieve more information about the activation using response expansion, for example: Instead of returning only the owner's name within the system hash, the response includes detailed information about the owner by using expand=owner. You can also expand the owner's company by using expand=owner.company. The response now includes information about the owner and the company he belongs to, if any. By using expand=host will include details about the system host. You can also expand the host's company by using expand=host.company. The response now includes information about the host and the company he belongs to

get/api/v4/partner/activations/{activation_id}

Request

Path parameters

activation_idinteger required

The Enlighten ID of the activation(system). System-generated.

Query parameters

expand'owner' | 'owner.company' | 'host' | 'host.company'

Retrieve more information about the activation. The expand query parameter is a comma-separated list of associations to expand. It may include the following:

Response

OK

system_idinteger

The Enlighten ID of this system. System-generated

system_namestring

The name of the system.

system_typestring

The type of the system. One of 'residential', 'commercial', or 'other'. Default 'residential'. Cannot be null.

statusstring

System's status.

timezonestring

System's timezone.

stageinteger

What stage of the activation process this activation is in. System-generated.

internet_connectionstring

How the system's Envoys connect to the Internet. Possible values are none, cellular, broadband, dialup. Use 'dialup' if the Internet connection is satellite or dial-up

leaseboolean

Whether the system is leased. Possible values true, false. Default false

operationalboolean

Whether this system is permitted to operate. Possible values true, false. Default true

owner_idinteger

The Enlighten ID of this system owner. System-generated. This field is optional.

host_idinteger

The Enlighten ID of this system host. System-generated. This field is optional.

battery_grid_modestring

Battery grid mode can be of two types - Export Only, Import Only

third_party_storage_device_installedboolean

If third party storage device is installed on the site.

third_party_storage_device_manufacturerstring

Manufacturer name of the third party storage device.

interconnection_application_dateinteger

Date in epoch format

permission_to_operateboolean

boolean (true / false)

installer_namestring

Name of the installer.

installer_idinteger

The Enlighten ID of the installer of this system

maintainer_namestring

Name of the maintainer.

maintainer_idinteger

The Enlighten ID of the maintainer of this system

uristring

URI for this activation

updated_atinteger

Activation last updated timestamp

referencestring

The identifier of this system as provided by the calling user's company. This attribute is not present if the calling user's company does not have a reference for this system.

other_referencesstring[]

The identifiers assigned to this activation by other companies which have access to it. This attribute is not present if there are no other references for this system.

allow_public_accessboolean

When true, the system will be eligible to appear in the public systems lists of Enphase and the system's installer. Default true

interconnect_dateinteger

When the system was approved to connect to the grid

installer_support_emailstring

Installer support email

sourcestring

The source of production measurements taken on the system. Possible values 'meter', 'microinverters'. When 'meter', production values come from a revenue-grade meter on the system. When 'microinverters', production values come from the microinverters on the system

array_typestring

The type of array installed. Possible values are fixed_open_rack, fixed_roof_mount, single_axis_tracking, single_axis_backtracking, dual_axis_tracking. All other values will be ignored. To unset array_type, pass null

attachment_typestring

How the microinverters are attached to the panels. Possible values are acm (AC Module), rack_mount (rack- or rail-mounted), zep (Zep Solar compatible), bipv (Building Integrated PV), frame_mount (Enphase Frame Mount), railless_mount (Other Railless Mount)

ensemble_envoystring

Specifies serial number of ensemble envoy in multi envoy system

production_modestring

Possible value is 'on' and 'off'

grid_profilestring

The grid profile to set on this system's microinverters. See GridProfiles API for how to retrieve a list of known profiles.

requested_profilestring
requested_report_freqstring
voltagestring

The supported voltage/phase associated with a commercial system inside North America. If system type is not commercial, or if the installer exists & installer's country is not inside North America, or if the system's country is not inside North America, then the voltage value would be null

envoy_serial_numbersstring[]

A list of Envoys installed on this system

expected_envoy_countinteger

Total envoys the system is supposed to have

expected_pcu_countinteger

Total PCUs the system is supposed to have

expected_nsr_countinteger

Total nsrs the system is supposed to have

expected_meter_countinteger

Total meters the system is supposed to have

expected_encharge_countinteger

Total encharges the system is supposed to have

expected_enpower_countinteger

Total enpowers the system is supposed to have

pv_manufacturerinteger

Enlighten ID of the PV manufacturer associated with the PV model installed on the system. See PvManufacturers for how to retrieve PV manufacturer IDs

pv_manufacturer_namestring

Name of the Custom PV Module Manufacturer associated with the system.

pv_modelinteger

Enlighten ID of the PV model installed on the system. See PvManufacturers and PvModels for how to retrieve PV model IDs

pv_model_namestring

Name of the Custom PV Module Model associated with the system.

pv_module_power_ratingnumber float

Power Rating (in W) of the PV module installed on the system.

pv_module_type1 | 2 | 3 | 4

Type ID of the PV module installed on the system. 1 -> 'Mono-facial', 2 -> 'Bi-facial', 3 -> 'Split cell', 4 -> 'Other'

Changes

No recorded changes to this operation across all 1 revision of this API.