Devices

Get an Organisation's Devices

Get the list of all devices for the specified organization ID. By default returns ALL devices with ALL fields.

Optional parameters:

device_type: Filter by specific device type (hp_atw, hp_wtw, inv, ev, wb)
device_steering: Only devices that are steered (on) or not (off)
manufacturer: Only devices whose model carries this manufacturer
status: Only devices in one of these health tones (good, warning, critical, not_steered; repeatable). Graded off the connection/monitoring/steering trio, the same tones …/devices/summary counts — a device with a pending partner action is filtered under its trio’s tone while its own tone field reads action_required.
fields: Comma-separated list of specific fields (e.g., “id,owner.email,device_model.manufacturer”)
page: Enable pagination by providing page number (1-based)
page_size: Items per page when pagination is enabled (default: 100)
sort: Order the whole fleet by status (worst first), last_data (oldest first) or owner; order flips it. Unsorted, devices come back device type by device type. sort=status ranks on the tone field as rendered, action_required first — unlike the status filter above, which grades the trio alone.

Field examples:

fields=id,owner.email,device_model.manufacturer
fields=id,connection_status,monitoring_status,battery_level

Restricted to staff and admins, plus Console Support agents reading across organisations.

GET

api

partners

v2.0

org

{org_id}

devices

Get an Organisation's Devices

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/devices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/devices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/devices', 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://api.example.com/api/partners/v2.0/org/{org_id}/devices",
  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://api.example.com/api/partners/v2.0/org/{org_id}/devices"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/devices")

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

[
  {
    "connection_status": "ok",
    "monitoring_status": "ok",
    "steering_status": "ok",
    "tone": "good",
    "device_model": {
      "device_type": {
        "short_name": "<string>",
        "long_name": "<string>"
      },
      "manufacturer": "<string>",
      "model": "<string>",
      "cloud_service_instructions": "<string>",
      "cloud_service_signup_link": "<string>",
      "year": 123,
      "cloud_service": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ac_rated_power_w": 123
    },
    "owner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "external_id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "service_health": {
      "evaluated_at": "2023-11-07T05:31:56Z",
      "components": [
        {
          "id": "oem_auth",
          "own": "yes",
          "ready": "yes",
          "attribution": "oem",
          "reason": "no_schedule",
          "since": "2023-11-07T05:31:56Z",
          "blocked_by": "oem_auth",
          "provider": "price_data"
        }
      ],
      "origin": "oem_auth"
    },
    "action_needed": false,
    "price_zone": "AT",
    "is_authenticated": false,
    "is_smart_optimization_active": false,
    "is_inverter_forced_mode_enabled": false,
    "actual_steering_state": "unknown",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_at": "2023-11-07T05:31:56Z",
    "pause_power_until": "2023-11-07T05:31:56Z",
    "is_pause_power_active": false,
    "external_device_id": "",
    "optimization_score": 123,
    "current_mode": "<string>",
    "comment": "<string>",
    "current_state_last_updated_at": "2023-11-07T05:31:56Z",
    "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
    "is_inverter_forced_mode_active": false,
    "inverter_forced_mode_since": "0001-01-01T00:00:00Z",
    "charge_target_min": 50,
    "charge_target_max": 123,
    "is_charge_policy_enabled": false,
    "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
    "minimum_charge_limit": 100,
    "charge_deadline_at": "06:00:00",
    "is_over_charge_allowed": false,
    "expected_max_charge_power": 3600,
    "charge_power_measured_at": "2023-11-07T05:31:56Z",
    "charge_time_remaining": 123,
    "charge_rate_w": 123,
    "is_fully_charged": false,
    "is_plugged_in": false,
    "is_charging": false,
    "battery_level": 123,
    "driving_range": 123,
    "battery_capacity_kwh": "0",
    "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
    "plug_state_evidence_at": "2023-11-07T05:31:56Z",
    "boost_stop_requested_at": "2023-11-07T05:31:56Z",
    "boost_for_next_session": false,
    "latitude": 123,
    "longitude": 123,
    "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
    "geo_fence_distance_m": 100,
    "consumption_last_day_kwh": 123,
    "consumption_last_week_kwh": 123,
    "consumption_last_month_kwh": 123,
    "consumption_last_updated_at": "2023-11-07T05:31:56Z",
    "battery_at_plug_in": 123,
    "steering_block_probed_at": "2023-11-07T05:31:56Z",
    "minimum_solar_coverage": 1,
    "hems_mode": "balanced",
    "hems_min_export_to_start_w": 2000,
    "hems_max_import_before_stopping_w": 4000,
    "hems_min_production_to_start_w": 3000,
    "hems_min_production_before_stopping_w": 2000,
    "token_refresh_status": "<string>",
    "token_refresh_last_succeeded_at": "2023-11-07T05:31:56Z",
    "token_refresh_degraded_since": "2023-11-07T05:31:56Z",
    "token_refresh_terminal_at": "2023-11-07T05:31:56Z",
    "token_refresh_terminal_reason": "<string>",
    "information_notifications": [
      "<string>"
    ],
    "embeddable_url": "<string>",
    "authorization_url": "<string>",
    "boost_state": "unavailable",
    "boost_feature_enabled": true
  }
]

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id

string<uuid>

required

The organization ID of the user's organization

Query Parameters

device_type

string

Filter by device type (hp_atw, hp_wtw, inv, ev, wb)

fields

string

Comma-separated list of specific fields to include

page

integer

Page number (1-based) - enables pagination

Required range: x >= 1

page_size

integer

default:100

Number of devices per page when pagination is enabled

Required range: 1 <= x <= 1000

string

Search by device model, external id, owner name/email, or device id prefix

device_steering

enum<string>

Filter by whether the device is steered (on) or not (off)

Available options:

on,

off

manufacturer

string

Filter by the device model's manufacturer

status

enum<string>[] | null

Only devices whose health tone is one of these (repeatable)

Available options:

good,

warning,

critical,

not_steered

sort

enum<string>

Sort key; direction via order. Ties break on device id

Available options:

status,

last_data,

owner

order

enum<string>

default:asc

Sort direction

Available options:

asc,

desc

health_capability

Available options:

monitoring,

steering,

intraday,

hems

health_reason

string

default:""

Maximum string length: 128

health_manufacturer

string

default:""

Maximum string length: 128

include_deleted

boolean

default:false

If true, includes soft-deleted

Response

200 - application/json

One object per device, each matching its device type's schema (anyOf of the four). When the fields query parameter is set, every object is a partial projection carrying only the requested (dot-nested) fields.

ElectricVehicleOutput
HeatPumpOutput
InverterOutput
WallboxOutput

connection_status

enum<string>

required

Available options:

ok,

warning,

error,

unknown

monitoring_status

enum<string>

required

Available options:

ok,

warning,

error,

unknown

steering_status

enum<string>

required

Available options:

ok,

warning,

error,

unknown

tone

required

The device's console health tone, and the only verdict a client should render: action_required when a partner-resolvable action is pending, else the worst of connection and monitoring, with not_steered for a healthy device nobody optimizes. Do not re-derive it from connection_status/monitoring_status/steering_status — those three are cue-blind and would report a device asking for reauthentication as healthy. The status filter on GET /org/{org_id}/devices and the tone counts on …/devices/summary grade the three statuses only, so a device with a pending action reads action_required here while being counted and filtered under its status tone.

Available options:

good,

warning,

critical,

not_steered

device_model

DeviceModelOutput · object | null

required

Show child attributes

owner

OwnerOutput · object

required

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

service_health

ServiceHealthOutput · object

required

Whether the platform is doing what it should for this vehicle, component by component, and where the problem starts when it is not. Every cell is a reading of state the evaluators already recorded, so a cell nothing has observed reads not_measured rather than a guess.

Show child attributes

action_needed

boolean

default:false

deprecated

Deprecated — use GET /org/{org_id}/notifications/status for per-device-type counts, or GET /org/{org_id}/notifications/actions?device_id=… for the specifics. True when at least one action is pending against this device and the partner must take that action before the device can resume normal operation.

price_zone

enum<string>

default:AT

Available options:

AT,

AT_HOURLY,

BE,

CH,

EE,

DE_LU,

HR,

HU,

IE_SEM,

IT_CNOR,

IT_CSUD,

IT_NORD,

IT_PUN,

IT_SARD,

IT_SICI,

IT_SUD,

PT,

RO,

SE_1,

SE_2,

SE_3,

SE_4,

UK

is_authenticated

boolean | null

default:false

is_smart_optimization_active

boolean

default:false

is_inverter_forced_mode_enabled

boolean

default:false

actual_steering_state

string

default:unknown

Maximum string length: 20

string<uuid> | null

deleted_at

string<date-time> | null

When set, the device is considered deleted.

pause_power_until

string<date-time> | null

is_pause_power_active

boolean

default:false

external_device_id

string | null

default:""

Maximum string length: 255

optimization_score

number | null

current_mode

string | null

comment

string | null

Maximum string length: 300

current_state_last_updated_at

string<date-time> | null

last_monitoring_executed_at

string<date-time> | null

is_inverter_forced_mode_active

boolean

default:false

inverter_forced_mode_since

string<date-time> | null

default:0001-01-01T00:00:00Z

charge_target_min

integer | null

default:50

charge_target_max

integer | null

Detected OEM-app charge cap (percent). NULL = unknown / no cap detected.

is_charge_policy_enabled

boolean | null

default:false

charge_policy_last_updated_at

string<date-time> | null

minimum_charge_limit

integer | null

default:100

charge_deadline_at

string<time> | null

default:06:00:00

is_over_charge_allowed

boolean | null

default:false

expected_max_charge_power

integer

default:3600

charge_power_measured_at

string<date-time> | null

charge_time_remaining

integer | null

charge_rate_w

integer | null

is_fully_charged

boolean | null

default:false

is_plugged_in

boolean | null

default:false

is_charging

boolean | null

default:false

battery_level

integer | null

driving_range

integer | null

battery_capacity_kwh

default:0

charge_state_last_updated_at

string<date-time> | null

plug_state_evidence_at

string<date-time> | null

Event time of the last accepted canonical plug-state write, from any source (Smartcar telemetry, OCPP wire). The arbitration watermark: a claim whose evidence time is not newer than this is stale and does not write. NULL = no claim yet, so anything wins.

boost_stop_requested_at

string<date-time> | null

Timestamp the API signalled a boost cancel (owned by the API, not the workflow). Drives BoostState.STOPPING until the workflow ends the boost and clears boost_active_at. Cleared by the API on an un-cancel (re-tap).

boost_for_next_session

boolean

default:false

latitude

number | null

longitude

number | null

coordinates_last_updated_at

string<date-time> | null

geo_fence_distance_m

number

default:100

consumption_last_day_kwh

consumption_last_week_kwh

consumption_last_month_kwh

consumption_last_updated_at

string<date-time> | null

battery_at_plug_in

number | null

Battery level at latest plug-in event

steering_block_probed_at

string<date-time> | null

Last steering-block recovery probe attempt. NULL = never probed.

minimum_solar_coverage

number

default:1

hems_mode

string

default:balanced

Maximum string length: 16

hems_min_export_to_start_w

integer

default:2000

hems_max_import_before_stopping_w

integer

default:4000

hems_min_production_to_start_w

integer

default:3000

hems_min_production_before_stopping_w

integer

default:2000

token_refresh_status

string | null

Maximum string length: 16

token_refresh_last_succeeded_at

string<date-time> | null

token_refresh_degraded_since

string<date-time> | null

token_refresh_terminal_at

string<date-time> | null

token_refresh_terminal_reason

string | null

Maximum string length: 200

information_notifications

string[] | null

embeddable_url

string | null

URL to embeddable onboarding form

authorization_url

string | null

Base URL for authorizing with the Podero server

boost_state

enum<string>

default:unavailable

Pure boost lifecycle, shared by EVs and wallboxes (SC-154). Describes only the boost, not whether the device is charging — normal optimizer-driven charging is AVAILABLE (boostable), not ONGOING.

Available options:

available,

requested,

unavailable,

ongoing,

stopping

boost_feature_enabled

boolean

default:true

Get an Organisation's Devices

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/devices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/devices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/devices', 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://api.example.com/api/partners/v2.0/org/{org_id}/devices",
  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://api.example.com/api/partners/v2.0/org/{org_id}/devices"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/devices")

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

[
  {
    "connection_status": "ok",
    "monitoring_status": "ok",
    "steering_status": "ok",
    "tone": "good",
    "device_model": {
      "device_type": {
        "short_name": "<string>",
        "long_name": "<string>"
      },
      "manufacturer": "<string>",
      "model": "<string>",
      "cloud_service_instructions": "<string>",
      "cloud_service_signup_link": "<string>",
      "year": 123,
      "cloud_service": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ac_rated_power_w": 123
    },
    "owner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "external_id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "service_health": {
      "evaluated_at": "2023-11-07T05:31:56Z",
      "components": [
        {
          "id": "oem_auth",
          "own": "yes",
          "ready": "yes",
          "attribution": "oem",
          "reason": "no_schedule",
          "since": "2023-11-07T05:31:56Z",
          "blocked_by": "oem_auth",
          "provider": "price_data"
        }
      ],
      "origin": "oem_auth"
    },
    "action_needed": false,
    "price_zone": "AT",
    "is_authenticated": false,
    "is_smart_optimization_active": false,
    "is_inverter_forced_mode_enabled": false,
    "actual_steering_state": "unknown",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_at": "2023-11-07T05:31:56Z",
    "pause_power_until": "2023-11-07T05:31:56Z",
    "is_pause_power_active": false,
    "external_device_id": "",
    "optimization_score": 123,
    "current_mode": "<string>",
    "comment": "<string>",
    "current_state_last_updated_at": "2023-11-07T05:31:56Z",
    "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
    "is_inverter_forced_mode_active": false,
    "inverter_forced_mode_since": "0001-01-01T00:00:00Z",
    "charge_target_min": 50,
    "charge_target_max": 123,
    "is_charge_policy_enabled": false,
    "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
    "minimum_charge_limit": 100,
    "charge_deadline_at": "06:00:00",
    "is_over_charge_allowed": false,
    "expected_max_charge_power": 3600,
    "charge_power_measured_at": "2023-11-07T05:31:56Z",
    "charge_time_remaining": 123,
    "charge_rate_w": 123,
    "is_fully_charged": false,
    "is_plugged_in": false,
    "is_charging": false,
    "battery_level": 123,
    "driving_range": 123,
    "battery_capacity_kwh": "0",
    "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
    "plug_state_evidence_at": "2023-11-07T05:31:56Z",
    "boost_stop_requested_at": "2023-11-07T05:31:56Z",
    "boost_for_next_session": false,
    "latitude": 123,
    "longitude": 123,
    "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
    "geo_fence_distance_m": 100,
    "consumption_last_day_kwh": 123,
    "consumption_last_week_kwh": 123,
    "consumption_last_month_kwh": 123,
    "consumption_last_updated_at": "2023-11-07T05:31:56Z",
    "battery_at_plug_in": 123,
    "steering_block_probed_at": "2023-11-07T05:31:56Z",
    "minimum_solar_coverage": 1,
    "hems_mode": "balanced",
    "hems_min_export_to_start_w": 2000,
    "hems_max_import_before_stopping_w": 4000,
    "hems_min_production_to_start_w": 3000,
    "hems_min_production_before_stopping_w": 2000,
    "token_refresh_status": "<string>",
    "token_refresh_last_succeeded_at": "2023-11-07T05:31:56Z",
    "token_refresh_degraded_since": "2023-11-07T05:31:56Z",
    "token_refresh_terminal_at": "2023-11-07T05:31:56Z",
    "token_refresh_terminal_reason": "<string>",
    "information_notifications": [
      "<string>"
    ],
    "embeddable_url": "<string>",
    "authorization_url": "<string>",
    "boost_state": "unavailable",
    "boost_feature_enabled": true
  }
]

Device Models

Prices

Authentication

Organization

Device Simulator

API Reference

Organization Configuration

Platform

Users

User Charging Config

User Charging Sessions

User Electric Vehicles

Electric Vehicle Charge Policies

Electric Vehicle Charge Policy Overrides

Electric Vehicle Sessions

User Heat Pumps

User Solar Inverters

User Wallboxes

Wallbox HEMS Sessions

User Devices

User Notifications

Devices

Notifications

Notification Webhooks

Trading

Loadcurves

Loadcurves Confirmation

Device Onboarding Sessions

Cues

Simulator Connections

Trading Control

Get an Organisation's Devices

Authorizations

Path Parameters

Query Parameters

Response