Users

List users in the organization

List users within the specified organization.

By default returns ALL users (legacy, unbounded). Pass page to fetch one page at a time — same page/page_size params as GET /org//devices. Whale orgs (100k+ members) must page: the full response is large enough that nginx buffers it to disk.

Filters compose (AND) and apply before pagination, and every ordering breaks ties on member id, so a filtered/sorted page sequence is stable — the console’s cockpit walks it, and q with a member id / email / external id serves its ?user= deep link.

GET

api

partners

v2.0

org

{org_id}

users

List users in the organization

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

import requests

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

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

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

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "admin",
    "email": "<string>",
    "num_inverters": 123,
    "num_heat_pumps": 123,
    "num_electric_vehicles": 123,
    "num_wallboxes": 123,
    "support": {
      "attention_required": 123,
      "service_degraded": 123,
      "informational": 123
    },
    "health": "unhealthy",
    "external_user_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "is_onboarded": true,
    "push_notifications_enabled": true,
    "street_and_number": "<string>",
    "street_add_info": "<string>",
    "zip_code": "<string>",
    "town": "<string>",
    "country": "<string>",
    "latitude": 123,
    "longitude": 123,
    "language": "<string>",
    "last_login": "2023-11-07T05:31:56Z",
    "savings": 0,
    "joined_at": "2023-11-07T05:31:56Z",
    "manufacturers": [
      "<string>"
    ],
    "import_tariff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "export_tariff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_at": "2023-11-07T05:31:56Z",
    "latest_onboarding": {
      "outcome": "success",
      "at": "2023-11-07T05:31:56Z",
      "attempt_streak": 123
    }
  }
]

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 requested users

Query Parameters

page

integer

Page number (1-based) - enables pagination

Required range: x >= 1

page_size

integer

default:100

Number of users per page when pagination is enabled

Required range: 1 <= x <= 1000

string

Search by name, email, external user id, town, or exact member id. Up to 25 comma-separated terms match the union; more is a 422.

support

(enum<string> | string)[] | null

Only members owning a live device with a pending cue of one of these Support categories (repeatable, unioned); none selects the members owning no such device.

Available options:

attention_required,

service_degraded,

informational

health

enum<string>[] | null

Only members whose worst live-device service-health verdict is one of these (repeatable, unioned); a member with no live device matches none.

Available options:

unhealthy,

unknown,

healthy

role

enum<string>

Only members with this organization role. staff is a deprecated alias for support, normalised on the way in and removed in a future release; responses always carry support.

Available options:

admin,

support,

user,

guest

device_kind

enum<string>

Only members owning a device of this kind (any = at least one device)

Available options:

any,

ev,

hp,

inv,

wb

device_steering

enum<string>

Only members owning an operational device that is steered (on) or not (off). Composes with device_kind as a same-device condition: both must hold for one and the same device, so a member with a steered EV and an unsteered inverter matches device_kind=inv&device_steering=off but not device_kind=ev&device_steering=off. A member with no devices matches neither value.

Available options:

on,

off

manufacturer

string

Only members owning a device from this manufacturer

import_tariff

string

Only members on the retail tariff of this name for grid import — what they pay for consumption. none selects the members with none, who are priced on market prices.

export_tariff

string

Only members on the retail tariff of this name for grid export — what they earn for feed-in. none selects the members with none, who are priced on market prices.

tariff_kind

enum<string>

Only members whose import or export retail tariff is of this kind

Available options:

fixed,

spot_indexed,

time_of_use

joined_after

string<date>

Only members who joined on or after this UTC day

joined_before

string<date>

Only members who joined on or before this UTC day

engaged

boolean

true: only members who have ever owned a device or made an onboarding attempt in the last 7 days, hiding members created up front who never started onboarding.

sort

enum<string>

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

Available options:

email,

name,

joined,

last_login,

savings,

support,

health,

devices

order

enum<string>

default:asc

Sort direction

Available options:

asc,

desc

include_deleted

boolean

default:false

If true, includes soft-deleted

Response

200 - application/json

string<uuid>

required

organization_id

string<uuid>

required

role

enum<string>

required

Available options:

admin,

support,

user,

guest

string

required

num_inverters

integer

required

num_heat_pumps

integer

required

num_electric_vehicles

integer

required

num_wallboxes

integer

required

support

SupportCountsOutput · object

required

Pending cues per Support category, summed over the member's live devices.

Show child attributes

health

enum<string> | null

required

The worst service-health verdict over the member's live devices (unhealthy over unknown over healthy), read from the device status projection; null with no live device.

Available options:

unhealthy,

unknown,

healthy

external_user_id

string | null

first_name

string | null

last_name

string | null

is_onboarded

boolean | null

push_notifications_enabled

boolean

default:true

street_and_number

string | null

street_add_info

string | null

zip_code

string | null

town

string | null

country

string | null

latitude

number | null

longitude

number | null

language

string | null

savings

number

default:0

joined_at

string<date-time> | null

manufacturers

string[]

import_tariff_id

string<uuid> | null

export_tariff_id

string<uuid> | null

deleted_at

string<date-time> | null

latest_onboarding

LatestOnboardingOutput · object | null

Show child attributes

List users in the organization

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

import requests

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

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

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

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "admin",
    "email": "<string>",
    "num_inverters": 123,
    "num_heat_pumps": 123,
    "num_electric_vehicles": 123,
    "num_wallboxes": 123,
    "support": {
      "attention_required": 123,
      "service_degraded": 123,
      "informational": 123
    },
    "health": "unhealthy",
    "external_user_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "is_onboarded": true,
    "push_notifications_enabled": true,
    "street_and_number": "<string>",
    "street_add_info": "<string>",
    "zip_code": "<string>",
    "town": "<string>",
    "country": "<string>",
    "latitude": 123,
    "longitude": 123,
    "language": "<string>",
    "last_login": "2023-11-07T05:31:56Z",
    "savings": 0,
    "joined_at": "2023-11-07T05:31:56Z",
    "manufacturers": [
      "<string>"
    ],
    "import_tariff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "export_tariff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_at": "2023-11-07T05:31:56Z",
    "latest_onboarding": {
      "outcome": "success",
      "at": "2023-11-07T05:31:56Z",
      "attempt_streak": 123
    }
  }
]

Device Models

Prices

Authentication

Organization Branding

Organization

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

Trading Control

List users in the organization

Authorizations

Path Parameters

Query Parameters

Response