Skip to main content
GET
Count of members matching the filters

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

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

include_deleted
boolean
default:false

If true, includes soft-deleted

Response

200 - application/json

OK

Number of members matching the users-list filters — the filtered total the paginated list can't report itself, so the console can size its pager range and page count to the active filters instead of the org-wide total.

total
integer
required