> ## Documentation Index > Fetch the complete documentation index at: https://docs.nomos.energy/llms.txt > Use this file to discover all available pages before exploring further. # List assets > List the assets of your households. ## OpenAPI ````yaml /openapi/openapi.gauss.json get /assets openapi: 3.0.0 info: title: Nomos API version: 2026-09-08.gauss servers: - url: https://api.nomos.energy description: production security: [] tags: - name: Plans - name: Leads - name: Subscriptions - name: Customers - name: Households - name: Assets - name: Usage - name: Prices - name: Invoices - name: Smart Meter Orders - name: Grid Fee Reductions - name: Market Partners - name: Events - name: Authentication paths: /assets: get: tags: - Assets summary: List assets description: List the assets of your households. parameters: - schema: type: string nullable: true required: false name: cursor in: query - schema: type: number minimum: 1 maximum: 100 default: 10 required: false name: limit in: query - schema: nullable: true description: >- **Filterable fields:** - `household` (string) - `external_id` (string) - `type` (enum): household_net, household_residual, inverter, solar, battery, wallbox, heat_pump - `status` (enum): active, decommissioned - `parent_inverter` (string) See [Filtering Documentation](https://docs.nomos.energy/guides/filtering) for supported operators and syntax. example: value required: false description: >- **Filterable fields:** - `household` (string) - `external_id` (string) - `type` (enum): household_net, household_residual, inverter, solar, battery, wallbox, heat_pump - `status` (enum): active, decommissioned - `parent_inverter` (string) See [Filtering Documentation](https://docs.nomos.energy/guides/filtering) for supported operators and syntax. name: filter[field][operator] in: query responses: '200': description: List the assets of your households. content: application/json: schema: type: object properties: object: type: string enum: - list items: type: array items: $ref: '#/components/schemas/Asset' next_page: type: string nullable: true example: >- eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0= has_more: type: boolean default: false required: - object - items '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). content: application/json: schema: $ref: '#/components/schemas/ErrBadRequest' examples: Malformed filter: summary: Malformed filter value: code: BAD_REQUEST message: >- Invalid filter syntax: 'filter[status]'. Expected format: filter[field][operator]=value requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/BAD_REQUEST Limit out of range: summary: Limit out of range value: code: BAD_REQUEST message: 'Too big: expected number to be <=100' requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/BAD_REQUEST errors: - code: too_big field: limit message: 'Too big: expected number to be <=100' Unsupported version header: summary: Unsupported version header value: code: BAD_REQUEST message: Version header 2026-01-01.foo is invalid. requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/BAD_REQUEST '401': description: The client must authenticate itself to get the requested response. content: application/json: schema: $ref: '#/components/schemas/ErrUnauthorized' examples: No token: summary: No token value: code: UNAUTHORIZED message: No authorization header provided. requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/UNAUTHORIZED Expired token: summary: Expired token value: code: UNAUTHORIZED message: Token expired requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/UNAUTHORIZED Invalid token: summary: Invalid token value: code: UNAUTHORIZED message: Invalid or malformed token requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/UNAUTHORIZED '403': description: >- The client does not have the necessary permissions to access the resource. content: application/json: schema: $ref: '#/components/schemas/ErrForbidden' examples: Token without scope: summary: Token without scope value: code: FORBIDDEN message: 'Insufficient scope: read:* required.' requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: https://docs.nomos.energy/api-references/errors/FORBIDDEN Role without access: summary: Role without access value: code: FORBIDDEN message: Forbidden to access this route. requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: https://docs.nomos.energy/api-references/errors/FORBIDDEN '422': description: >- The request was well-formed but was unable to be followed due to semantic errors. content: application/json: schema: $ref: '#/components/schemas/ErrUnprocessableEntity' examples: Invalid filter value: summary: Invalid filter value value: code: UNPROCESSABLE_ENTITY message: 'Invalid option: expected one of "active"|"decommissioned"' requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY errors: - code: invalid_value field: filter[status][eq] message: >- Invalid option: expected one of "active"|"decommissioned" '500': description: >- The server has encountered a situation it doesn't know how to handle. content: application/json: schema: $ref: '#/components/schemas/ErrInternalServerError' examples: Unexpected error: summary: Unexpected error value: code: INTERNAL_SERVER_ERROR message: Internal Server Error requestId: 37a04f8f-e791-491c-81e1-86cd304649bb docs: >- https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR security: - Bearer: [] components: schemas: Asset: oneOf: - $ref: '#/components/schemas/BatteryAsset' - $ref: '#/components/schemas/InverterAsset' - $ref: '#/components/schemas/SolarAsset' - $ref: '#/components/schemas/WallboxAsset' - $ref: '#/components/schemas/HeatPumpAsset' - $ref: '#/components/schemas/HouseholdNetAsset' - $ref: '#/components/schemas/HouseholdResidualAsset' discriminator: propertyName: type mapping: battery: '#/components/schemas/BatteryAsset' inverter: '#/components/schemas/InverterAsset' solar: '#/components/schemas/SolarAsset' wallbox: '#/components/schemas/WallboxAsset' heat_pump: '#/components/schemas/HeatPumpAsset' household_net: '#/components/schemas/HouseholdNetAsset' household_residual: '#/components/schemas/HouseholdResidualAsset' description: >- A device in a household, or one of the two assets Nomos creates per household. It carries the type data object named like its `type`, with every field present and `null` where unknown. ErrBadRequest: type: object properties: code: type: string enum: - BAD_REQUEST description: The error code related to the status code. example: BAD_REQUEST message: type: string description: A human readable message describing the issue. example: 'invalid_type in ''end'': Required' requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/BAD_REQUEST errors: type: array items: type: object properties: code: type: string enum: - invalid_type - too_big - too_small - invalid_format - not_multiple_of - unrecognized_keys - invalid_union - invalid_key - invalid_element - invalid_value - custom - unserviceable_zip - ended_subscription - duplicate_grid_reduction - missing_smart_meter - missing_module_1 - unsupported_product - unsupported_meter_order - duplicate_meter_order - unsupported_meter - out_of_period_meter_reading - unsupported_meter_reading - duplicate_meter_reading - implausible_meter_reading - duplicate_customer_email - invalid_iban - upgrade_api_version - withdrawal_not_allowed - invalid_termination_date - subscription_not_started - missing_household - invalid_household_customer - invalid_household_meter - duplicate_consumption_subscription - invalid_inverter - read_only_asset - duplicate_external_id - asset_has_children - asset_decommissioned example: invalid_type field: type: string example: favoriteNumbers.1 message: type: string example: 'Invalid input: expected string, received number' required: - code - field - message description: >- Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff. required: - code - message - requestId - docs ErrUnauthorized: type: object properties: code: type: string enum: - UNAUTHORIZED description: The error code related to the status code. example: UNAUTHORIZED message: type: string description: A human readable message describing the issue. example: Invalid or malformed token requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/UNAUTHORIZED errors: type: array items: type: object properties: code: type: string enum: - invalid_type - too_big - too_small - invalid_format - not_multiple_of - unrecognized_keys - invalid_union - invalid_key - invalid_element - invalid_value - custom - unserviceable_zip - ended_subscription - duplicate_grid_reduction - missing_smart_meter - missing_module_1 - unsupported_product - unsupported_meter_order - duplicate_meter_order - unsupported_meter - out_of_period_meter_reading - unsupported_meter_reading - duplicate_meter_reading - implausible_meter_reading - duplicate_customer_email - invalid_iban - upgrade_api_version - withdrawal_not_allowed - invalid_termination_date - subscription_not_started - missing_household - invalid_household_customer - invalid_household_meter - duplicate_consumption_subscription - invalid_inverter - read_only_asset - duplicate_external_id - asset_has_children - asset_decommissioned example: invalid_type field: type: string example: favoriteNumbers.1 message: type: string example: 'Invalid input: expected string, received number' required: - code - field - message description: >- Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff. required: - code - message - requestId - docs ErrForbidden: type: object properties: code: type: string enum: - FORBIDDEN description: The error code related to the status code. example: FORBIDDEN message: type: string description: A human readable message describing the issue. example: You are not allowed to access this resource requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/FORBIDDEN errors: type: array items: type: object properties: code: type: string enum: - invalid_type - too_big - too_small - invalid_format - not_multiple_of - unrecognized_keys - invalid_union - invalid_key - invalid_element - invalid_value - custom - unserviceable_zip - ended_subscription - duplicate_grid_reduction - missing_smart_meter - missing_module_1 - unsupported_product - unsupported_meter_order - duplicate_meter_order - unsupported_meter - out_of_period_meter_reading - unsupported_meter_reading - duplicate_meter_reading - implausible_meter_reading - duplicate_customer_email - invalid_iban - upgrade_api_version - withdrawal_not_allowed - invalid_termination_date - subscription_not_started - missing_household - invalid_household_customer - invalid_household_meter - duplicate_consumption_subscription - invalid_inverter - read_only_asset - duplicate_external_id - asset_has_children - asset_decommissioned example: invalid_type field: type: string example: favoriteNumbers.1 message: type: string example: 'Invalid input: expected string, received number' required: - code - field - message description: >- Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff. required: - code - message - requestId - docs ErrUnprocessableEntity: type: object properties: code: type: string enum: - UNPROCESSABLE_ENTITY description: The error code related to the status code. example: UNPROCESSABLE_ENTITY message: type: string description: A human readable message describing the issue. example: >- invalid_enum_value in 'status': Invalid enum value. Expected 'pending' | 'active' | 'ended' requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY errors: type: array items: type: object properties: code: type: string enum: - invalid_type - too_big - too_small - invalid_format - not_multiple_of - unrecognized_keys - invalid_union - invalid_key - invalid_element - invalid_value - custom - unserviceable_zip - ended_subscription - duplicate_grid_reduction - missing_smart_meter - missing_module_1 - unsupported_product - unsupported_meter_order - duplicate_meter_order - unsupported_meter - out_of_period_meter_reading - unsupported_meter_reading - duplicate_meter_reading - implausible_meter_reading - duplicate_customer_email - invalid_iban - upgrade_api_version - withdrawal_not_allowed - invalid_termination_date - subscription_not_started - missing_household - invalid_household_customer - invalid_household_meter - duplicate_consumption_subscription - invalid_inverter - read_only_asset - duplicate_external_id - asset_has_children - asset_decommissioned example: invalid_type field: type: string example: favoriteNumbers.1 message: type: string example: 'Invalid input: expected string, received number' required: - code - field - message description: >- Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff. required: - code - message - requestId - docs ErrInternalServerError: type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The error code related to the status code. example: INTERNAL_SERVER_ERROR message: type: string description: A human readable message describing the issue. example: Internal Server Error requestId: type: string description: The request id to be used for debugging and error reporting. example: 37a04f8f-e791-491c-81e1-86cd304649bb docs: type: string description: The docs related to the error code. example: >- https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR errors: type: array items: type: object properties: code: type: string enum: - invalid_type - too_big - too_small - invalid_format - not_multiple_of - unrecognized_keys - invalid_union - invalid_key - invalid_element - invalid_value - custom - unserviceable_zip - ended_subscription - duplicate_grid_reduction - missing_smart_meter - missing_module_1 - unsupported_product - unsupported_meter_order - duplicate_meter_order - unsupported_meter - out_of_period_meter_reading - unsupported_meter_reading - duplicate_meter_reading - implausible_meter_reading - duplicate_customer_email - invalid_iban - upgrade_api_version - withdrawal_not_allowed - invalid_termination_date - subscription_not_started - missing_household - invalid_household_customer - invalid_household_meter - duplicate_consumption_subscription - invalid_inverter - read_only_asset - duplicate_external_id - asset_has_children - asset_decommissioned example: invalid_type field: type: string example: favoriteNumbers.1 message: type: string example: 'Invalid input: expected string, received number' required: - code - field - message description: >- Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff. required: - code - message - requestId - docs BatteryAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: type: string nullable: true description: >- The Nomos ID of the inverter the asset sits behind. Set on solar and on a battery behind a hybrid inverter. example: ha_i9k3l7w2e5r8t1y4u6o0p3as external_id: type: string nullable: true description: Your own ID. Null on `household_net` and `household_residual`. example: partner-bat-1 status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: true manufacturer: type: string nullable: true example: BYD model: type: string nullable: true example: Battery-Box Premium HVS 10.2 installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: serial_number: '34118573' decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - battery battery: type: object properties: capacity_kwh: type: number nullable: true minimum: 0 exclusiveMinimum: true description: Nominal capacity in kWh. example: 10.2 max_in_kw: type: number nullable: true minimum: 0 description: Max charge power in kW. example: 5 max_out_kw: type: number nullable: true minimum: 0 description: Max discharge power in kW. example: 5 min_soc: type: number nullable: true minimum: 0 maximum: 1 description: Lowest state of charge as a share of capacity, 0 to 1. example: 0.1 max_soc: type: number nullable: true minimum: 0 maximum: 1 description: Highest state of charge as a share of capacity, 0 to 1. example: 0.95 required: - capacity_kwh - max_in_kw - max_out_kw - min_soc - max_soc required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type - battery title: battery InverterAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: type: string nullable: true description: >- The Nomos ID of the inverter the asset sits behind. Set on solar and on a battery behind a hybrid inverter. example: null external_id: type: string nullable: true description: Your own ID. Null on `household_net` and `household_residual`. example: partner-wb-1 status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: false manufacturer: type: string nullable: true example: null model: type: string nullable: true example: null installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: null decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - inverter inverter: type: object properties: kind: type: string nullable: true enum: - hybrid - pv - battery - null description: 'Role of the inverter: hybrid, PV only or battery only.' example: hybrid max_out_kw: type: number nullable: true minimum: 0 description: Rated AC output in kW. example: 10 max_in_kw: type: number nullable: true minimum: 0 description: >- Max power drawn from the grid in kW, for hybrid inverters that charge the battery from the grid. example: 10 phases: anyOf: - type: number enum: - 1 - type: number enum: - 3 - nullable: true example: 3 mppt_count: type: integer nullable: true minimum: 1 example: 2 required: - kind - max_out_kw - max_in_kw - phases - mppt_count required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type - inverter title: inverter SolarAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: type: string nullable: true description: >- The Nomos ID of the inverter the asset sits behind. Set on solar and on a battery behind a hybrid inverter. example: null external_id: type: string nullable: true description: Your own ID. Null on `household_net` and `household_residual`. example: partner-wb-1 status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: false manufacturer: type: string nullable: true example: null model: type: string nullable: true example: null installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: null decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - solar solar: type: object properties: peak_power_kwp: type: number nullable: true minimum: 0 exclusiveMinimum: true description: >- DC nameplate of the modules in kWp, not the AC limit of the inverter. example: 9.8 azimuth_deg: type: number nullable: true minimum: 0 maximum: 360 exclusiveMaximum: true description: Orientation in degrees from north, 180 is south. example: 180 tilt_deg: type: number nullable: true minimum: 0 maximum: 90 description: Tilt in degrees, 0 is flat. example: 35 mastr_unit_id: type: string nullable: true description: Unit number in the Marktstammdatenregister. example: SEE912345678901 required: - peak_power_kwp - azimuth_deg - tilt_deg - mastr_unit_id required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type - solar title: solar WallboxAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: type: string nullable: true description: >- The Nomos ID of the inverter the asset sits behind. Set on solar and on a battery behind a hybrid inverter. example: null external_id: type: string nullable: true description: Your own ID. Null on `household_net` and `household_residual`. example: partner-wb-1 status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: false manufacturer: type: string nullable: true example: null model: type: string nullable: true example: null installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: null decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - wallbox wallbox: type: object properties: max_in_kw: type: number nullable: true minimum: 0 description: Max charge power in kW. example: 11 min_in_kw: type: number nullable: true minimum: 0 description: Min charge power in kW. example: 1.4 phases: anyOf: - type: number enum: - 1 - type: number enum: - 3 - nullable: true example: 3 required: - max_in_kw - min_in_kw - phases required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type - wallbox title: wallbox HeatPumpAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: type: string nullable: true description: >- The Nomos ID of the inverter the asset sits behind. Set on solar and on a battery behind a hybrid inverter. example: null external_id: type: string nullable: true description: Your own ID. Null on `household_net` and `household_residual`. example: partner-wb-1 status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: false manufacturer: type: string nullable: true example: null model: type: string nullable: true example: null installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: null decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - heat_pump heat_pump: type: object properties: control_interface: type: string nullable: true enum: - sg_ready - power - null example: sg_ready max_in_kw: type: number nullable: true minimum: 0 description: Rated electrical power in kW. example: 3.5 required: - control_interface - max_in_kw required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type - heat_pump title: heat_pump HouseholdNetAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: nullable: true external_id: nullable: true status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: false manufacturer: type: string nullable: true example: null model: type: string nullable: true example: null installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: null decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - household_net required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type title: household_net HouseholdResidualAsset: type: object properties: object: type: string enum: - asset id: type: string example: ha_b7q2m1k8v4n0x3c9l5p2r7td household: type: string example: dom_k3v9x2m7n1b4v8c2x6z0q5wd parent_inverter: nullable: true external_id: nullable: true status: type: string enum: - active - decommissioned description: A decommissioned asset stays readable, by its ID and in the list. example: active is_steerable: type: boolean example: false manufacturer: type: string nullable: true example: null model: type: string nullable: true example: null installed_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null metadata: type: object nullable: true additionalProperties: nullable: true example: null decommissioned_at: anyOf: - type: string - type: string format: date-time - nullable: true example: null created_at: anyOf: - type: string - type: string format: date-time example: '2026-10-06T09:12:44Z' type: type: string enum: - household_residual required: - object - id - household - parent_inverter - external_id - status - is_steerable - manufacturer - model - installed_at - metadata - decommissioned_at - created_at - type title: household_residual securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.