Skip to main content
GET
Get details about a user

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 user's organization

user_id
string<uuid>
required

The user ID of the specified user

Query Parameters

include_deleted
boolean
default:false

If true, includes soft-deleted

Response

200 - application/json

OK

The users list / single-user GET row: UserOutput plus what only those reads fold.

id
string<uuid>
required
organization_id
string<uuid>
required
role
enum<string>
required
Available options:
admin,
support,
user,
guest
email
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.

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
last_login
string<date-time> | 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