Skip to main content
GET
List assets

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string | null
limit
integer
default:10
Required range: 1 <= x <= 100
filter[field][operator]
any | null

Filterable fields:

  • household (string): eq, in
  • external_id (string): eq, in
  • type (enum: household_net, household_residual, inverter, solar, battery, wallbox, heat_pump): eq, ne, in
  • status (enum: active, decommissioned): eq, ne, in
  • parent_inverter (string): eq, in
  • created_at (date): gte, lte
  • updated_at (date): gte, lte

Any other field or operator returns 400. See Filtering Documentation for the syntax.

Example:

"value"

Response

List the assets of your households.

object
enum<string>
required
Available options:
list
items
(battery · object | inverter · object | solar · object | wallbox · object | heat_pump · object | household_net · object | household_residual · object)[]
required

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.

next_page
string | null
Example:

"eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="

has_more
boolean
default:false