List meter readings
Changed onRetrieve all meter readings for the organization with cursor pagination. Customer users will only see their own. Use filter[subscription][eq]=<id> to scope to a single subscription.
Request
- Base URLhttps://api.nomos.energy
- URLhttps://api.nomos.energy/meter-readings
- AuthHTTP bearer
Query parameters
Filterable fields:
- type (string): eq, ne, in, is_null, contains, starts_with, ends_with
- subscription (string): eq, ne, in, is_null, contains, starts_with, ends_with
- created_at (date): gte, lte, is_null
Any other field or operator returns 400. See Filtering Documentation for the syntax.
Response
Retrieve all meter readings for the organization with cursor pagination. Customer users will only see their own. Use filter[subscription][eq]=<id> to scope to a single subscription.
Example response
{
"items": [
{
"id": "read_k3n9x2v7q1m8p4t6w0z5c2bd",
"customer": "cus_a8n8ol7yd4h0wohx824f0bui",
"subscription": "sub_rocbrf1u5e48mm0reeqoag90",
"meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
"value": 150,
"timestamp": "2024-03-13T23:00:00.000Z",
"type": "customer_report",
"created_at": "2024-03-14T12:00:03.512Z"
}
],
"next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}Changes
- breaking
for the
queryrequest parameterlimit, the type changed fromnumbertointeger - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the
customenum value from the//response property for the response status - info
removed the
customenum value from the//response property for the response status - info
removed the
customenum value from the//response property for the response status - info
removed the
duplicate_customer_emailenum value from the//response property for the response status - info
removed the
duplicate_customer_emailenum value from the//response property for the response status - info
removed the
duplicate_customer_emailenum value from the//response property for the response status - info
removed the
duplicate_grid_reductionenum value from the//response property for the response status - info
removed the
duplicate_grid_reductionenum value from the//response property for the response status - info
removed the
duplicate_grid_reductionenum value from the//response property for the response status - info
removed the
duplicate_meter_orderenum value from the//response property for the response status - info
removed the
duplicate_meter_orderenum value from the//response property for the response status - info
removed the
duplicate_meter_orderenum value from the//response property for the response status - info
removed the
duplicate_meter_readingenum value from the//response property for the response status - info
removed the
duplicate_meter_readingenum value from the//response property for the response status - info
removed the
duplicate_meter_readingenum value from the//response property for the response status - info
removed the
ended_subscriptionenum value from the//response property for the response status - info
removed the
ended_subscriptionenum value from the//response property for the response status - info
removed the
ended_subscriptionenum value from the//response property for the response status - info
removed the
implausible_meter_readingenum value from the//response property for the response status - info
removed the
implausible_meter_readingenum value from the//response property for the response status - info
removed the
implausible_meter_readingenum value from the//response property for the response status - info
removed the
invalid_elementenum value from the//response property for the response status - info
removed the
invalid_elementenum value from the//response property for the response status - info
removed the
invalid_elementenum value from the//response property for the response status - info
removed the
invalid_formatenum value from the//response property for the response status - info
removed the
invalid_formatenum value from the//response property for the response status - info
removed the
invalid_formatenum value from the//response property for the response status - info
removed the
invalid_ibanenum value from the//response property for the response status - info
removed the
invalid_ibanenum value from the//response property for the response status - info
removed the
invalid_ibanenum value from the//response property for the response status - info
removed the
invalid_keyenum value from the//response property for the response status - info
removed the
invalid_keyenum value from the//response property for the response status - info
removed the
invalid_keyenum value from the//response property for the response status - info
removed the
invalid_termination_dateenum value from the//response property for the response status - info
removed the
invalid_termination_dateenum value from the//response property for the response status - info
removed the
invalid_termination_dateenum value from the//response property for the response status - info
removed the
invalid_typeenum value from the//response property for the response status - info
removed the
invalid_typeenum value from the//response property for the response status - info
removed the
invalid_typeenum value from the//response property for the response status - info
removed the
invalid_unionenum value from the//response property for the response status - info
removed the
invalid_unionenum value from the//response property for the response status - info
removed the
invalid_unionenum value from the//response property for the response status - info
removed the
invalid_valueenum value from the//response property for the response status - info
removed the
invalid_valueenum value from the//response property for the response status - info
removed the
invalid_valueenum value from the//response property for the response status - info
removed the
missing_module_1enum value from the//response property for the response status - info
removed the
missing_module_1enum value from the//response property for the response status - info
removed the
missing_module_1enum value from the//response property for the response status - info
removed the
missing_smart_meterenum value from the//response property for the response status - info
removed the
missing_smart_meterenum value from the//response property for the response status - info
removed the
missing_smart_meterenum value from the//response property for the response status - info
removed the
not_multiple_ofenum value from the//response property for the response status - info
removed the
not_multiple_ofenum value from the//response property for the response status - info
removed the
not_multiple_ofenum value from the//response property for the response status - info
removed the
out_of_period_meter_readingenum value from the//response property for the response status - info
removed the
out_of_period_meter_readingenum value from the//response property for the response status - info
removed the
out_of_period_meter_readingenum value from the//response property for the response status - info
removed the
subscription_not_startedenum value from the//response property for the response status - info
removed the
subscription_not_startedenum value from the//response property for the response status - info
removed the
subscription_not_startedenum value from the//response property for the response status - info
removed the
too_bigenum value from the//response property for the response status - info
removed the
too_bigenum value from the//response property for the response status - info
removed the
too_bigenum value from the//response property for the response status - info
removed the
too_smallenum value from the//response property for the response status - info
removed the
too_smallenum value from the//response property for the response status - info
removed the
too_smallenum value from the//response property for the response status - info
removed the
unrecognized_keysenum value from the//response property for the response status - info
removed the
unrecognized_keysenum value from the//response property for the response status - info
removed the
unrecognized_keysenum value from the//response property for the response status - info
removed the
unserviceable_zipenum value from the//response property for the response status - info
removed the
unserviceable_zipenum value from the//response property for the response status - info
removed the
unserviceable_zipenum value from the//response property for the response status - info
removed the
unsupported_meterenum value from the//response property for the response status - info
removed the
unsupported_meterenum value from the//response property for the response status - info
removed the
unsupported_meterenum value from the//response property for the response status - info
removed the
unsupported_meter_orderenum value from the//response property for the response status - info
removed the
unsupported_meter_orderenum value from the//response property for the response status - info
removed the
unsupported_meter_orderenum value from the//response property for the response status - info
removed the
unsupported_meter_readingenum value from the//response property for the response status - info
removed the
unsupported_meter_readingenum value from the//response property for the response status - info
removed the
unsupported_meter_readingenum value from the//response property for the response status - info
removed the
unsupported_productenum value from the//response property for the response status - info
removed the
unsupported_productenum value from the//response property for the response status - info
removed the
unsupported_productenum value from the//response property for the response status - info
removed the
upgrade_api_versionenum value from the//response property for the response status - info
removed the
upgrade_api_versionenum value from the//response property for the response status - info
removed the
upgrade_api_versionenum value from the//response property for the response status - info
removed the
withdrawal_not_allowedenum value from the//response property for the response status - info
removed the
withdrawal_not_allowedenum value from the//response property for the response status - info
removed the
withdrawal_not_allowedenum value from the//response property for the response status
- breaking