List all groups
curl --request GET \
--url https://energy-api.flatpeak.com/groups \
--header 'Authorization: Bearer <token>'import requests
url = "https://energy-api.flatpeak.com/groups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://energy-api.flatpeak.com/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://energy-api.flatpeak.com/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://energy-api.flatpeak.com/groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://energy-api.flatpeak.com/groups")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://energy-api.flatpeak.com/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"url": "/groups",
"next_cursor": null,
"data": [
{
"id": "grp_2f6a9c1d8e3b5a7c4d0e9f1a",
"object": "group",
"live_mode": true,
"name": "Fast responders",
"operator_id": "opr_6a3548352c0d07e89d47b7f1",
"filter": {
"device_types": [
"BATTERY_STORAGE"
],
"program_id": "vpr_6a1f8e375db9de605baadd46",
"zone_id": "zon_9b3c5d7e1f2a4b6c8d0e2f4a",
"min_response_seconds": null,
"max_response_seconds": 600
},
"device_count": 42,
"time_created": "2026-08-12T09:30:00Z"
},
{
"id": "grp_7d1e3f5a9c2b4d6e8f0a1b3c",
"object": "group",
"live_mode": true,
"name": "Pilot homes",
"operator_id": "opr_6a3548352c0d07e89d47b7f1",
"filter": null,
"device_count": 2,
"time_created": "2026-07-02T14:05:00Z"
}
]
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}Groups
List all groups
Returns the VPP operators’ groups that touch your fleet: groups holding at least one of your devices, or referenced by a VPP event that applies to them. Most recently created first.
GET
/
groups
List all groups
curl --request GET \
--url https://energy-api.flatpeak.com/groups \
--header 'Authorization: Bearer <token>'import requests
url = "https://energy-api.flatpeak.com/groups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://energy-api.flatpeak.com/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://energy-api.flatpeak.com/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://energy-api.flatpeak.com/groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://energy-api.flatpeak.com/groups")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://energy-api.flatpeak.com/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"url": "/groups",
"next_cursor": null,
"data": [
{
"id": "grp_2f6a9c1d8e3b5a7c4d0e9f1a",
"object": "group",
"live_mode": true,
"name": "Fast responders",
"operator_id": "opr_6a3548352c0d07e89d47b7f1",
"filter": {
"device_types": [
"BATTERY_STORAGE"
],
"program_id": "vpr_6a1f8e375db9de605baadd46",
"zone_id": "zon_9b3c5d7e1f2a4b6c8d0e2f4a",
"min_response_seconds": null,
"max_response_seconds": 600
},
"device_count": 42,
"time_created": "2026-08-12T09:30:00Z"
},
{
"id": "grp_7d1e3f5a9c2b4d6e8f0a1b3c",
"object": "group",
"live_mode": true,
"name": "Pilot homes",
"operator_id": "opr_6a3548352c0d07e89d47b7f1",
"filter": null,
"device_count": 2,
"time_created": "2026-07-02T14:05:00Z"
}
]
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}Query Parameters
Response
Group list response.
Standard envelope for paginated list endpoints.
Was this page helpful?

