Retrieve a device
curl --request GET \
--url https://fleet-api.flatpeak.com/devices/{device_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://fleet-api.flatpeak.com/devices/{device_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://fleet-api.flatpeak.com/devices/{device_id}', 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://fleet-api.flatpeak.com/devices/{device_id}",
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://fleet-api.flatpeak.com/devices/{device_id}"
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://fleet-api.flatpeak.com/devices/{device_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://fleet-api.flatpeak.com/devices/{device_id}")
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{
"id": "dev_63a6087272941ef077a8fd3e",
"object": "device",
"live_mode": true,
"device_type": "BATTERY_STORAGE",
"oem_id": "oem_6a3a8dada72cd0a249ff9528",
"hardware": {
"hardware_id": "PU2426A103557",
"manufacturer": "Nova Systems",
"model_code": "PICOXN2",
"model_name": "Pico Ultimate"
},
"location_id": "loc_641b90b758fb8e6293716e40",
"consent_scopes": [
"TELEMETRY",
"CONTROL",
"LOCATION"
],
"dispatch_limits": {
"max_import_power_kw": 5,
"max_export_power_kw": 5,
"storage_capacity_kwh": 13.5,
"pv_peak_power_kw": 6.2
},
"response_time": {
"pickup_seconds": 42,
"apply_seconds": 18,
"total_seconds": 60,
"sample_count": 37
},
"telemetry": {
"state_data_delayed": false,
"device_meters_data_delayed": false
},
"time_last_seen": "2026-07-08T19:30:00Z",
"time_created": "2026-01-20T09:30:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "access_denied",
"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": "access_denied",
"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": "access_denied",
"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": "access_denied",
"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": "access_denied",
"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": "access_denied",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}Devices
Retrieve a device
Retrieves a device.
GET
/
devices
/
{device_id}
Retrieve a device
curl --request GET \
--url https://fleet-api.flatpeak.com/devices/{device_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://fleet-api.flatpeak.com/devices/{device_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://fleet-api.flatpeak.com/devices/{device_id}', 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://fleet-api.flatpeak.com/devices/{device_id}",
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://fleet-api.flatpeak.com/devices/{device_id}"
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://fleet-api.flatpeak.com/devices/{device_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://fleet-api.flatpeak.com/devices/{device_id}")
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{
"id": "dev_63a6087272941ef077a8fd3e",
"object": "device",
"live_mode": true,
"device_type": "BATTERY_STORAGE",
"oem_id": "oem_6a3a8dada72cd0a249ff9528",
"hardware": {
"hardware_id": "PU2426A103557",
"manufacturer": "Nova Systems",
"model_code": "PICOXN2",
"model_name": "Pico Ultimate"
},
"location_id": "loc_641b90b758fb8e6293716e40",
"consent_scopes": [
"TELEMETRY",
"CONTROL",
"LOCATION"
],
"dispatch_limits": {
"max_import_power_kw": 5,
"max_export_power_kw": 5,
"storage_capacity_kwh": 13.5,
"pv_peak_power_kw": 6.2
},
"response_time": {
"pickup_seconds": 42,
"apply_seconds": 18,
"total_seconds": 60,
"sample_count": 37
},
"telemetry": {
"state_data_delayed": false,
"device_meters_data_delayed": false
},
"time_last_seen": "2026-07-08T19:30:00Z",
"time_created": "2026-01-20T09:30:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "access_denied",
"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": "access_denied",
"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": "access_denied",
"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": "access_denied",
"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": "access_denied",
"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": "access_denied",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}Authorizations
Authenticate with the bearer_token obtained from the authentication endpoint.
Response
Device response.
A device connected to your account.
Flatpeak OEM ID: the OEM that connects the device. See list all OEMs.
Pattern:
^oem_[A-Za-z0-9]+$Example:
"oem_6a3a8dada72cd0a249ff9528"
Flatpeak Location ID of the property the device sits behind. Devices at the same property share it; aggregate per location to avoid double counting. The address, coordinates, timezone and currency are on the location.
Pattern:
^[a-z]{2,4}_[A-Za-z0-9]+$Example:
"loc_641b90b758fb8e6293716e40"
Consent scopes the customer has granted you for this device. Grant and revocation times are in consent history.
| Scope | Grants |
|---|---|
TELEMETRY | Device state and meter data |
CONTROL | Dispatch |
LOCATION | Geolocation |
SETTINGS | Read and write operating settings |
Available options:
TELEMETRY, CONTROL, LOCATION, SETTINGS Example:
["TELEMETRY", "CONTROL", "LOCATION"]
Was this page helpful?

