Skip to main content
GET
List an organization's information notifications.

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.

Query Parameters

owner_id
string<uuid> | null

Restrict to a single owner's notifications.

device_id
string<uuid> | null

Restrict to a single device's notifications.

device_type
enum<string> | null

Restrict to one device type.

Available options:
heat_pump,
inverter,
electric_vehicle,
wallbox
code
enum<string>[] | null

Restrict to notifications whose cue carries one of these codes (repeatable).

Available options:
reauthenticate,
virtual_key_required,
subscription_required,
remote_access_disabled,
terms_not_accepted,
discarded,
information,
steering_recovery_failed,
oem_charge_cap_detected,
wallbox_current_cap_detected,
battery_mode_reset_failed,
device_offline,
fully_charged,
soc_input_requested,
vendor_access_required,
premium_subscription_required
created_after
string<date-time> | null

Only notifications sent at or after this time.

created_before
string<date-time> | null

Only notifications sent at or before this time.

limit
integer
default:50

Page size.

Required range: 1 <= x <= 100
offset
integer
default:0

Items to skip.

Required range: x >= 0

Response

200 - application/json

OK

id
string<uuid>
required

The notification's id.

message
string
required

The message shown to the user.

sent_at
string<date-time>
required

When the notification was sent.

dismissed
boolean
required

Whether the user has already dismissed it.

Link the caller follows to dismiss it.

device_id
string<uuid> | null

The device the notification relates to, if any.

device_type
string | null

The device's type key (e.g. electric_vehicle), matching the status roll-up keys.

origin_code
enum<string>
default:information

The originating cue code (e.g. device_offline), so callers rank/label by real severity. information for a cue-less manual/bulk send.

Available options:
reauthenticate,
virtual_key_required,
subscription_required,
remote_access_disabled,
terms_not_accepted,
discarded,
information,
steering_recovery_failed,
oem_charge_cap_detected,
wallbox_current_cap_detected,
battery_mode_reset_failed,
device_offline,
fully_charged,
soc_input_requested,
vendor_access_required,
premium_subscription_required
owner
OwnerIdentity · object | null

The device owner (id + email/name), so callers skip the device→owner lookup.