List leads
Changed onRetrieve all leads with cursor pagination. Leads for feed-in plans are only available from the 2026-05-27.curie API version onwards.
Request
- Base URLhttps://api.nomos.energy
- URLhttps://api.nomos.energy/leads
- AuthHTTP bearer
Query parameters
Filterable fields:
- created_at (date): gte, lte, is_null
Any other field or operator returns 400. See Filtering Documentation for the syntax.
Response
Retrieve all leads with cursor pagination. Leads for feed-in plans are only available from the 2026-05-27.curie API version onwards.
Example response
{
"items": [
{
"id": "lead_a8n8ol7yd4h0wohx824f0bui",
"subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
"link": "https://nomos.checkout.energy?id=lead_a8n8ol7yd4h0wohx824f0bui",
"created_by": "john.doe@example.com",
"metadata": {
"utm_source": "google",
"utm_campaign": "campaign_name",
"user_id": "1234567890"
}
}
],
"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