Notifications

List an organization's pending user-facing action projections.

Render pending cues + unread information notifications into a merged, newest-first list of DeviceAction projections. Both source tables are capped at limit + offset rows at SQL before the Python-side merge + sort + slice, so page cost scales with the requested window, not the org’s total pending backlog.

code filters both sources on the cue code: an action cue matches its own code, an information notification matches its linked cue’s code (so cue-less sends drop out under a code filter). created_after/created_before bound each source’s own timestamp (cue created_at / notification sent_at).

GET

api

partners

v2.0

org

{org_id}

notifications

actions

List an organization's pending user-facing action projections.

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

import requests

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

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}/notifications/actions', 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}/notifications/actions",
  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}/notifications/actions"

	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}/notifications/actions")

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

[
  {
    "code": "reauthenticate",
    "resolution_link": {
      "url": "<string>",
      "required_parameters": [
        "<string>"
      ]
    },
    "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "device_type": "<string>",
    "owner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z"
  }
]

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 actions.

device_id

string<uuid> | null

Restrict to a single device's actions.

device_type

enum<string> | null

Restrict to one device type.

Available options:

heat_pump,

inverter,

electric_vehicle,

wallbox

code

enum<string>[] | null

Restrict to actions 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 actions created at or after this time.

created_before

string<date-time> | null

Only actions created 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

ReauthenticateProjection
InformationActionProjection
SocInputRequestedProjection

Action requiring the partner to reauthenticate the user against an upstream provider.

Once more action codes are introduced, expose them as sibling classes (e.g. FooAction with code: Literal["foo"]) and combine them into a discriminated union (Annotated[ReauthenticateAction | FooAction, Field(discriminator="code")]) so OpenAPI consumers can branch on code to select the right shape.

code

string

required

Discriminator identifying this as a reauthentication action.

Allowed value: "reauthenticate"

resolution_link

ResolutionLinkSchema · object

required

Link the caller follows to start the reauthentication.

Show child attributes

device_id

string<uuid> | null

The device this action belongs to.

device_type

string | null

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

owner

OwnerIdentity · object | null

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

Show child attributes

created_at

string<date-time> | null

When the action was raised (the originating cue's creation time).

List an organization's pending user-facing action projections.

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

import requests

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

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}/notifications/actions', 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}/notifications/actions",
  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}/notifications/actions"

	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}/notifications/actions")

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

[
  {
    "code": "reauthenticate",
    "resolution_link": {
      "url": "<string>",
      "required_parameters": [
        "<string>"
      ]
    },
    "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "device_type": "<string>",
    "owner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Device Models

Prices

Authentication

Organization

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

Devices

Notifications

Notification Webhooks

Trading

Loadcurves

Loadcurves Confirmation

Device Onboarding Sessions

Cues

List an organization's pending user-facing action projections.

Authorizations

Path Parameters

Query Parameters

Response