Get Power Management

GET /v3/sites/{site}/power-management

Get Power Management

cURL

curl --request GET \
  --url https://app.plugchoice.com/api/v3/sites/{site}/power-management \
  --header 'Authorization: Bearer <token>'

200

{
  "groups": [
    {
      "id": 123,
      "isRoot": true,
      "totalAmps": 123,
      "netType": "<string>",
      "method": "<string>",
      "peakShaving": {
        "enabled": true,
        "threshold": 123
      },
      "meter": {
        "id": 123,
        "uuid": "<string>",
        "type": "<string>",
        "serialNumber": "<string>"
      },
      "solarSettings": {
        "additionalAmps": 123,
        "alwaysCharge": true,
        "alwaysChargeAmps": 123,
        "smartChargingChargeOnSolarExport": true
      },
      "chargers": [
        {}
      ],
      "subgroups": [
        {}
      ]
    }
  ],
  "unattachedChargers": [
    {}
  ],
  "allChargers": [
    {
      "id": 123,
      "uuid": "<string>",
      "label": "<string>",
      "status": "<string>",
      "groupId": 123
    }
  ],
  "realTimeData": {},
  "meterData": {}
}

Returns the power management status for the specified location, including the hierarchical group structure, chargers, connectors, and real-time metrics for load management visualization.

site · string · required

The UUID of the location.

Response

groups · array

An array of top-level load balancing group objects.

Show group object

id · integer

The numeric ID of the group.

isRoot · boolean

Whether this is a root-level group.

totalAmps · integer

The total available amperage for the group.

netType · string

The electrical network type (e.g., TT, TN, IT).

method · string

The load balancing method.

peakShaving · object

Peak shaving configuration.

Show peakShaving

enabled · boolean

Whether peak shaving is enabled.

threshold · integer

The peak shaving threshold in amps.

meter · object

The attached meter, or null if none.

Show meter

id · integer

The numeric ID of the meter.

uuid · string

The UUID of the meter.

type · string

The meter type.

serialNumber · string

The serial number of the meter.

solarSettings · object

Solar integration settings.

Show solarSettings

additionalAmps · integer

Additional amperage from solar.

alwaysCharge · boolean

Whether to always charge when solar is available.

alwaysChargeAmps · integer

Minimum amperage when solar always charge is enabled.

smartChargingChargeOnSolarExport · boolean

Whether to charge on solar export.

chargers · array

An array of charger objects assigned to this group.

subgroups · array

An array of nested subgroup objects (same structure as group).

unattachedChargers · array

An array of chargers not assigned to any group.

allChargers · array

A flat array of all location chargers with group assignment info.

Show charger summary

id · integer

The numeric ID of the charger.

uuid · string

The UUID of the charger.

label · string

The charger’s identity label.

status · string

The connection status of the charger.

groupId · integer

The ID of the group the charger is assigned to, or null.

realTimeData · object

A map of data keys to their current values for real-time load management metrics (available, requested, and allocated amperage per phase).

meterData · object

A map of meter IDs to their current power readings.