Skip to main content
GET
Retrieve a household

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Example:

"dom_mi4f0oda6x9m7gcsvjk0ole1"

Response

Retrieve the household details

A household groups the contracts at one metering point: one consumption subscription at a time, plus the feed-in subscriptions on that same meter. It belongs to one customer and stays the same when they cancel and sign up again. A separately metered device, such as a heat pump with its own meter and consumption subscription, is a household of its own, so one customer at one address can have two.

object
enum<string>
required

Type of the object, always 'household'

Available options:
household
id
string
required

Unique identifier for the household

Example:

"dom_mi4f0oda6x9m7gcsvjk0ole1"

display_name
string | null
required

Human-readable name of the household

Example:

"Torstraße 119"

created_at
required

Timestamp when the household was created

Example:

"2024-03-14T12:00:00Z"

updated_at
required

Timestamp when the household was updated

Example:

"2024-03-14T12:00:00Z"

customer
Person · object
required
address
object | null
required

The household's address: the delivery address of its most recently created subscription. Null for a household without subscriptions.