--- title: "Retrieves an Activation by id" method: GET path: "/api/v4/partner/activations/{activation_id}" tags: ["Activations"] --- # Retrieves an Activation by id `GET /api/v4/partner/activations/{activation_id}` ## Request - Base URL: `https://api-qa2.enphaseenergy.com` - URL: `https://api-qa2.enphaseenergy.com/api/v4/partner/activations/{activation_id}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) 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 ## Path parameters - `activation_id` integer, required ## Query parameters - `expand` 'owner' | 'owner.company' | 'host' | 'host.company' ## Response `200` OK - object - `system_id` integer: The Enlighten ID of this system. System-generated - `system_name` string: The name of the system. - `system_type` string: The type of the system. One of 'residential', 'commercial', or 'other'. Default 'residential'. Cannot be null. - `status` string: System's status. - `timezone` string: System's timezone. - `stage` integer: What stage of the activation process this activation is in. System-generated. - `internet_connection` string: 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 - `lease` boolean: Whether the system is leased. Possible values true, false. Default false - `operational` boolean: Whether this system is permitted to operate. Possible values true, false. Default true - `owner` object: Name of the system owner. Owner must be an Enlighten user. If the user of the API is a self-installer, the owner must be himself. If the query parameter 'expand=owner' passed in the request owner detail will appear in the response - `first_name` string - `last_name` string - `email` string - `phone` string - `active` boolean: Whether the user is allowed to log in to Enlighten. Values true, false. Default true. - `user_id` integer - `user_roles` string[]: What type of user this is in Enlighten. Possible values are ['self_installer']. For self installer user user_roles will be ['self_installer']. For other users user_roles will be empty. - `enlighten_emails` boolean - `enlighten_view` string - `uri` string - `updated_at` integer - `company` object: A hash of information about the owner's company. Use the query parameter 'expand=owner.company' to get owner company detail - `company_id` integer - `company_name` string - `location` string - `roles` string[]: What type of company this is in Enphase. Possible values are ['installer']. For installer company roles will be ['installer']. For other role roles will be empty. - `uri` string - `owner_id` integer: The Enlighten ID of this system owner. System-generated. This field is optional. - `host` object: Name of the system host. Please see “Specifying an Owner and Lease Arrangement”, above, for more information. If the query parameter 'expand=host' passed in the request host detail will appear in the response - `first_name` string - `last_name` string - `email` string - `phone` string - `active` boolean: Whether the user is allowed to log in to Enlighten. Values true, false. Default true. - `user_id` integer - `user_roles` string[]: What type of user this is in Enlighten. Possible values are ['self_installer']. For self installer user user_roles will be ['self_installer']. For other users user_roles will be empty. - `enlighten_emails` boolean - `enlighten_view` string - `updated_at` integer - `company` object: A hash of information about the system host's company. Use the query parameter 'expand=host.company' to get system host company detail - `company_id` integer - `company_name` string - `location` string - `roles` string[]: What type of company this is in Enphase. Possible values are ['installer']. For installer company roles will be ['installer']. For other role roles will be empty. - `uri` string - `uri` string - `host_id` integer: The Enlighten ID of this system host. System-generated. This field is optional. - `authorized_subcontractors` object[]: List of sub-contractors of this system. - `authorized_subcontractor_id` integer: The Enlighten ID of the sub-contractor of this system. System-generated. - `authorized_subcontractor_name` string: Name of the sub-contractor of this system. - `status` string: Current status of the subcontractor for the site. This field will be shown only for pending and rejected sub-contractors. - `grid_connection_type` object: Possible values for parameter: 1 – Net Billing Tariff (NEM 3.0), 2 – Net Metering, 3 – Net Feed-in tariff, 4 – Gross Feed-in tariff, 5 – Solar and/or Storage (with utility service), 6 – Full Off‑Grid (without utility service), 7 – Legacy: Net Metering Tariff, 8 – Legacy: Net Metering Tariff (with Hourly Dynamic Pricing), 9 – Smart Solar Billing, 10 – Smart Solar Billing (with Hourly Dynamic Pricing) - `type` integer - `value` string - `battery_grid_mode` string: Battery grid mode can be of two types - Export Only, Import Only - `third_party_storage_device_installed` boolean: If third party storage device is installed on the site. - `third_party_storage_device_manufacturer` string: Manufacturer name of the third party storage device. - `interconnection_application_date` integer: Date in epoch format - `permission_to_operate` boolean: boolean (true / false) - `installer_name` string: Name of the installer. - `installer_id` integer: The Enlighten ID of the installer of this system - `maintainer_name` string: Name of the maintainer. - `maintainer_id` integer: The Enlighten ID of the maintainer of this system - `uri` string: URI for this activation - `updated_at` integer: Activation last updated timestamp - `reference` string: 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_references` string[]: 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_access` boolean: When true, the system will be eligible to appear in the public systems lists of Enphase and the system's installer. Default true - `interconnect_date` integer: When the system was approved to connect to the grid - `installer_support_email` string: Installer support email - `source` string: 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_type` string: 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_type` string: 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_envoy` string: Specifies serial number of ensemble envoy in multi envoy system - `production_mode` string: Possible value is 'on' and 'off' - `grid_profile` string: The grid profile to set on this system's microinverters. See GridProfiles API for how to retrieve a list of known profiles. - `requested_profile` string - `requested_report_freq` string - `voltage` string: 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_numbers` string[]: A list of Envoys installed on this system - `expected_envoy_count` integer: Total envoys the system is supposed to have - `expected_pcu_count` integer: Total PCUs the system is supposed to have - `expected_nsr_count` integer: Total nsrs the system is supposed to have - `expected_meter_count` integer: Total meters the system is supposed to have - `expected_encharge_count` integer: Total encharges the system is supposed to have - `expected_enpower_count` integer: Total enpowers the system is supposed to have - `pv_manufacturer` integer: 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_name` string: Name of the Custom PV Module Manufacturer associated with the system. - `pv_model` integer: Enlighten ID of the PV model installed on the system. See PvManufacturers and PvModels for how to retrieve PV model IDs - `pv_model_name` string: Name of the Custom PV Module Model associated with the system. - `pv_module_power_rating` number, float: Power Rating (in W) of the PV module installed on the system. - `pv_module_type` 1 | 2 | 3 | 4: Type ID of the PV module installed on the system. 1 -> 'Mono-facial', 2 -> 'Bi-facial', 3 -> 'Split cell', 4 -> 'Other' - `encharge` object[]: Encharge detail - `envoy_serial_number` string: Envoy serial number - `encharge_serial_numbers` string[]: Encharge serial numbers - `enpower` object[]: Enpower detail - `envoy_serial_number` string: Envoy serial number - `enpower_serial_numbers` string[]: Enpower serial numbers - `address` object: The location of the system. Use the ISO 3166-1 2-letter code for the country. Latitude and longitude are calculated by Enlighten, not provided by the client - `street1` string: Street line 1 - `city` string: City - `state` string: State - `postal_code` string: Postal code - `country` string: Country - `latitude` integer: Latitude - `longitude` integer: Longitude - `street2` string: Street line 2. This field is Optional ## Other responses - `401`: Unauthorized - `404`: Not found - `405`: Method Not Allowed - `429`: Too Many Requests - `501`: Not Implemented --- [API](https://skmtc.dev/enphase/apis/commissioning-api.md) - [All operations](https://skmtc.dev/enphase/apis/commissioning-api/llms.txt) - [OpenAPI document](https://skmtc.dev/enphase/apis/commissioning-api/revisions/73a4001046e2?raw)