Skip to main content
GET
Get the user's charging configuration

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 whose charging configuration to read

Response

200 - application/json

OK

smart_charging_mode
enum<string>
required

User-facing charging mode on the partner-API wire — the projection of the DesiredSteering subset {NO_STEERING, DAY_AHEAD, HEMS, DAY_AHEAD_HEMS}.

Only the Day-Ahead + HEMS nibbles are user-selectable here; Intraday and Curtailment are folded into the same projection (a Day-Ahead+Intraday device still reads spot). Use to_desired_steering / wire_mode_from_desired to cross the boundary — never compare a DesiredSteering against one of these directly.

Available options:
none,
spot,
hems,
hems_and_spot
mode_conflict
boolean
required
config_divergence
boolean
required
devices
DeviceModeOutput · object[]
required
available_modes
ModeAvailabilityOutput · object[]
required
hems_eligible
boolean
required
hems_ineligible_reasons
enum<string>[]
required

Why a mode is unavailable (or HEMS ineligible). Stable wire codes the frontend maps to unlock hints — e.g. a locked HEMS row rendering "Connect an inverter".

Available options:
no_ev,
no_battery_capacity,
no_actuator,
wallbox_not_modulating,
no_inverter,
inverter_no_export_data
thresholds
ThresholdsOutput · object | null
required
health_warning
HealthWarningOutput · object | null
required
status
SmartChargingStatusOutput · object
required