Skip to main content
GET
/
api
/
partners
/
v2.0
/
org
/
{org_id}
/
users
/
{user_id}
/
wallboxes
Get a user's wallboxes
curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"
    },
    "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",
    "price_zone": "AT",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_at": "2023-11-07T05:31:56Z",
    "lifecycle_state": "authenticated",
    "lifecycle_error": "<string>",
    "pause_power_until": "2023-11-07T05:31:56Z",
    "is_pause_power_active": false,
    "external_device_id": "",
    "is_authenticated": false,
    "is_smart_optimization_active": false,
    "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_enabled": false,
    "is_inverter_forced_mode_active": false,
    "inverter_forced_mode_since": "0001-01-01T00:00:00Z",
    "is_trading_enabled": false,
    "actual_steering_state": "unknown",
    "charge_target_min": 50,
    "charge_target_max": 80,
    "charge_power_max_w": 7000,
    "supports_current_modulation": false,
    "supports_phase_switching": false,
    "phases": 1,
    "min_amps": 6,
    "max_amps": 16,
    "capabilities_last_refreshed_at": "2023-11-07T05:31:56Z",
    "hems_min_export_to_start_w": 2000,
    "hems_max_import_before_stopping_w": 4000,
    "firmware_version": "<string>",
    "is_ocpp_connected": false,
    "ocpp_connected_last_updated_at": "2023-11-07T05:31:56Z",
    "total_energy_delivered_wh": 123,
    "is_charge_policy_enabled": false,
    "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
    "minimum_charge_limit": 80,
    "charge_deadline_at": "2023-11-07T05:31:56Z",
    "is_over_charge_allowed": false,
    "charge_time_remaining": 123,
    "charge_rate_w": 123,
    "is_fully_charged": false,
    "is_plugged_in": false,
    "is_charging": false,
    "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
    "consumption_last_day_kwh": 123,
    "consumption_last_week_kwh": 123,
    "consumption_last_month_kwh": 123,
    "consumption_last_updated_at": "2023-11-07T05:31:56Z",
    "needs_gateway": false,
    "embeddable_url": "<string>",
    "authorization_url": "<string>",
    "action_needed": false,
    "has_notification": false
  }
]

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

​
user_id
string<uuid>
required

The user ID of the user whom the wallbox belongs to

Query Parameters

​
include_deleted
boolean
default:false

If true, includes soft-deleted

Response

200 - application/json

OK

​
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
​
device_model
DeviceModelOutput · object
required
​
owner
OwnerOutput · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
mode
enum<string>
required

User-facing wallbox state pill. Derived from is_authenticated, is_plugged_in, and is_charging. See Wallbox.mode for the truth table.

Available options:
READY,
PLUGGED_IN,
CHARGING,
UNAVAILABLE,
UNKNOWN
​
connection
enum<string>
required

User-facing wallbox WS-presence dot. Derived from is_authenticated + is_ocpp_connected. See Wallbox.connection for the truth table.

Available options:
online,
offline,
never_connected
​
price_zone
enum<string>
default:AT
Available options:
AT,
AT_HOURLY,
BE,
CH,
EE,
DE_LU,
HU,
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
​
id
string<uuid> | null
​
deleted_at
string<date-time> | null

When set, the device is considered deleted.

​
lifecycle_state
string
default:authenticated
Maximum string length: 20
​
lifecycle_error
string | null

Error metadata when lifecycle_state is 'error'.

​
pause_power_until
string<date-time> | null
​
is_pause_power_active
boolean
default:false
​
external_device_id
string | null
default:""
Maximum string length: 255
​
is_authenticated
boolean | null
default:false
​
is_smart_optimization_active
boolean
default:false
​
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_enabled
boolean
default:false
​
is_inverter_forced_mode_active
boolean
default:false
​
inverter_forced_mode_since
string<date-time> | null
default:0001-01-01T00:00:00Z
​
is_trading_enabled
boolean
default:false
​
actual_steering_state
string
default:unknown
Maximum string length: 20
​
charge_target_min
integer | null
default:50
​
charge_target_max
integer | null
default:80
​
charge_power_max_w
integer
default:7000
​
supports_current_modulation
boolean
default:false
​
supports_phase_switching
boolean
default:false
​
phases
integer
default:1
​
min_amps
integer
default:6
​
max_amps
integer
default:16
​
capabilities_last_refreshed_at
string<date-time> | null
​
hems_min_export_to_start_w
integer
default:2000
​
hems_max_import_before_stopping_w
integer
default:4000
​
firmware_version
string | null
Maximum string length: 32
​
is_ocpp_connected
boolean
default:false
​
ocpp_connected_last_updated_at
string<date-time> | null
​
total_energy_delivered_wh
integer | null
​
is_charge_policy_enabled
boolean | null
default:false
​
charge_policy_last_updated_at
string<date-time> | null
​
minimum_charge_limit
integer | null
default:80
​
charge_deadline_at
string<date-time> | null
​
is_over_charge_allowed
boolean | null
default:false
​
charge_time_remaining
integer | null
​
charge_rate_w
number | null
​
is_fully_charged
boolean | null
default:false
​
is_plugged_in
boolean | null
default:false
​
is_charging
boolean | null
default:false
​
charge_state_last_updated_at
string<date-time> | null
​
consumption_last_day_kwh
​
consumption_last_week_kwh
​
consumption_last_month_kwh
​
consumption_last_updated_at
string<date-time> | null
​
needs_gateway
boolean | null
default:false
​
embeddable_url
string | null

URL to embeddable onboarding form

​
authorization_url
string | null

Base URL for authorizing with the Podero server

​
action_needed
boolean
default:false

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. The actions field on the detail response carries the specifics.

​
has_notification
boolean
default:false

True when the device has at least one unread information notification for the owner.