Skip to main content
GET
List users in the organization

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
q
string

Search by name, email, external user id, town, or exact member id

status
enum<string>[] | null

Only members whose operational status is one of these buckets (repeatable)

Available options:
disabled,
communication-error,
steering-error,
actions-required,
troubleshooting,
communication-warning,
steering-warning,
normal
role
enum<string>

Only members with this organization role

Available options:
admin,
staff,
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 an operational 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

sort
enum<string>

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

Available options:
email,
name,
joined,
last_login,
savings,
status,
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

OK

id
string<uuid>
required
organization_id
string<uuid>
required
role
enum<string>
required
Available options:
admin,
staff,
user,
guest
email
string
required
num_inverters
integer
required
num_heat_pumps
integer
required
num_electric_vehicles
integer
required
num_wallboxes
integer
required
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
last_login
string<date-time> | null
savings
number
default:0
joined_at
string<date-time> | null
status
enum<string>
default:disabled
Available options:
disabled,
communication-error,
steering-error,
actions-required,
troubleshooting,
communication-warning,
steering-warning,
normal
manufacturers
string[]
import_tariff_id
string<uuid> | null
export_tariff_id
string<uuid> | null