Skip to main content
GET
/
v3
/
sites
/
{site}
/
groups
List Groups
curl --request GET \
  --url https://app.plugchoice.com/api/v3/sites/{site}/groups \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "site_id": 123,
  "group_id": 123,
  "meter_id": 123,
  "total_amps": 123,
  "net_type": "<string>",
  "method": "<string>",
  "solar_additional_amps": 123,
  "solar_always_charge": true,
  "solar_always_charge_amps": 123,
  "smart_charging_charge_on_solar_export": true,
  "peak_shaving_enabled": true,
  "peak_shaving_threshold": 123,
  "created_at": "<string>",
  "updated_at": "<string>"
}
Returns a list of load balancing groups for the specified location. Returns up to 25 groups.
​
site
string
required
The UUID of the location.

​
Response

The response is an array of group objects.
​
id
integer
The numeric ID of the group.
​
site_id
integer
The numeric ID of the location this group belongs to.
​
group_id
integer
The ID of the parent group, or null if this is a root group.
​
meter_id
integer
The ID of the attached meter, or null.
​
total_amps
integer
The total available amperage for the group.
​
net_type
string
The electrical network type. One of TN, TT, or IT. May be null.
​
method
string
The load balancing method. One of boost or solar.
​
solar_additional_amps
integer
Additional amperage from solar.
​
solar_always_charge
boolean
Whether to always allow charging when solar is available.
​
solar_always_charge_amps
integer
Minimum amperage when solar always charge is enabled.
​
smart_charging_charge_on_solar_export
boolean
Whether to charge on solar export.
​
peak_shaving_enabled
boolean
Whether peak shaving is enabled for this group.
​
peak_shaving_threshold
integer
The peak shaving threshold in amps.
​
created_at
string
ISO 8601 timestamp of when the group was created.
​
updated_at
string
ISO 8601 timestamp of when the group was last updated.