{"items":[{"type":"group","label":"docs","items":[{"type":"link","fsPath":"docs/auth.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/docs/auth","routeSlug":"/docs/auth","relativePathFromDirectory":"docs/auth.md"},{"type":"link","fsPath":"docs/errors.md","metadata":{"type":"markdown"},"label":"Error response format","link":"/docs/errors","routeSlug":"/docs/errors","relativePathFromDirectory":"docs/errors.md"},{"type":"link","fsPath":"docs/expand.md","metadata":{"type":"markdown"},"label":"Expanding Responses","link":"/docs/expand","routeSlug":"/docs/expand","relativePathFromDirectory":"docs/expand.md"},{"type":"link","fsPath":"docs/home_batteries.md","metadata":{"type":"markdown"},"label":"Home Batteries","link":"/docs/home_batteries","routeSlug":"/docs/home_batteries","relativePathFromDirectory":"docs/home_batteries.md"},{"type":"group","label":"howto","items":[{"type":"link","fsPath":"docs/howto/onboarding_custom.md","metadata":{"type":"markdown"},"label":"Onboarding vehicles, EVSEs and inverters","link":"/docs/howto/onboarding_custom","routeSlug":"/docs/howto/onboarding_custom","relativePathFromDirectory":"docs/howto/onboarding_custom.md"},{"type":"link","fsPath":"docs/howto/onboarding_users.md","metadata":{"type":"markdown"},"label":"Onboarding Users","link":"/docs/howto/onboarding_users","routeSlug":"/docs/howto/onboarding_users","relativePathFromDirectory":"docs/howto/onboarding_users.md"}]},{"type":"link","fsPath":"docs/intro.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/docs/intro","routeSlug":"/docs/intro","relativePathFromDirectory":"docs/intro.md"},{"type":"link","fsPath":"docs/pagination.md","metadata":{"type":"markdown"},"label":"Pagination","link":"/docs/pagination","routeSlug":"/docs/pagination","relativePathFromDirectory":"docs/pagination.md"},{"type":"link","fsPath":"docs/promo_code_in_use.md","metadata":{"type":"markdown"},"label":"Promo Code In Use Error","link":"/docs/promo_code_in_use","routeSlug":"/docs/promo_code_in_use","relativePathFromDirectory":"docs/promo_code_in_use.md"},{"type":"link","fsPath":"docs/promo_code_invalid.md","metadata":{"type":"markdown"},"label":"Promo Code Invalid Error","link":"/docs/promo_code_invalid","routeSlug":"/docs/promo_code_invalid","relativePathFromDirectory":"docs/promo_code_invalid.md"},{"type":"link","fsPath":"docs/rate_limiting.md","metadata":{"type":"markdown"},"label":"Rate limits","link":"/docs/rate_limiting","routeSlug":"/docs/rate_limiting","relativePathFromDirectory":"docs/rate_limiting.md"},{"type":"link","fsPath":"docs/resource_ids.md","metadata":{"type":"markdown"},"label":"Resource IDs","link":"/docs/resource_ids","routeSlug":"/docs/resource_ids","relativePathFromDirectory":"docs/resource_ids.md"},{"type":"link","fsPath":"docs/sandbox.md","metadata":{"type":"markdown"},"label":"Sandbox environment for testing","link":"/docs/sandbox","routeSlug":"/docs/sandbox","relativePathFromDirectory":"docs/sandbox.md"},{"type":"link","fsPath":"docs/schedules.md","metadata":{"type":"markdown"},"label":"Schedules","link":"/docs/schedules","routeSlug":"/docs/schedules","relativePathFromDirectory":"docs/schedules.md"},{"type":"link","fsPath":"docs/solar.md","metadata":{"type":"markdown"},"label":"Solar","link":"/docs/solar","routeSlug":"/docs/solar","relativePathFromDirectory":"docs/solar.md"},{"type":"group","label":"understanding","items":[{"type":"link","fsPath":"docs/understanding/charging_sessions.md","metadata":{"type":"markdown"},"label":"Understanding Charging Data","link":"/docs/understanding/charging_sessions","routeSlug":"/docs/understanding/charging_sessions","relativePathFromDirectory":"docs/understanding/charging_sessions.md"},{"type":"link","fsPath":"docs/understanding/scheduler.md","metadata":{"type":"markdown"},"label":"The Scheduler","link":"/docs/understanding/scheduler","routeSlug":"/docs/understanding/scheduler","relativePathFromDirectory":"docs/understanding/scheduler.md"}]},{"type":"link","fsPath":"docs/user-header.md","metadata":{"type":"markdown"},"label":"EvEnergy-User Header","link":"/docs/user-header","routeSlug":"/docs/user-header","relativePathFromDirectory":"docs/user-header.md"},{"type":"link","fsPath":"docs/versioning.md","metadata":{"type":"markdown"},"label":"Versioning","link":"/docs/versioning","routeSlug":"/docs/versioning","relativePathFromDirectory":"docs/versioning.md"},{"type":"link","fsPath":"docs/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/docs/webhooks","routeSlug":"/docs/webhooks","relativePathFromDirectory":"docs/webhooks.md"}]},{"type":"link","label":"ev.energy v2 API","link":"/ev.energy-api-v2","routeSlug":"/ev.energy-api-v2"},{"type":"group","label":"Carbon","link":"/ev.energy-api-v2/carbon","routeSlug":"/ev.energy-api-v2/carbon","items":[{"label":"List carbon feeds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/carbon/get-carbon_feeds","routeSlug":"/ev.energy-api-v2/carbon/get-carbon_feeds","metadata":{"seo":{"title":"List carbon feeds","description":"List all carbon feeds visible to the authenticated client. Carbon feeds represent sources of carbon intensity data for specific regions or grids."}},"httpPath":"/carbon_feeds"},{"label":"Retrieve a carbon feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/carbon/get-carbon_feeds-carbon_feed_id","routeSlug":"/ev.energy-api-v2/carbon/get-carbon_feeds-carbon_feed_id","metadata":{"seo":{"title":"Retrieve a carbon feed","description":"Retrieve a specific carbon feed, representing a source of carbon intensity data for a region or grid."}},"httpPath":"/carbon_feeds/{carbon_feed_id}"},{"label":"List carbon intensity data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/carbon/get-carbon_feeds-carbon_feed_id-carbon_intensities","routeSlug":"/ev.energy-api-v2/carbon/get-carbon_feeds-carbon_feed_id-carbon_intensities","metadata":{"seo":{"title":"List carbon intensity data","description":"Returns a paginated list of carbon intensity data points for a specific carbon feed. Carbon intensity represents the amount of CO2 emissions per unit of electricity generated, measured in grams of CO2 per kilowatt-hour (gCO2/kWh)."}},"httpPath":"/carbon_feeds/{carbon_feed_id}/carbon_intensities"},{"type":"link","label":"CarbonFeed","link":"/ev.energy-api-v2/carbon/carbonfeed","routeSlug":"/ev.energy-api-v2/carbon/carbonfeed","httpVerb":"schema"},{"type":"link","label":"CarbonIntensity","link":"/ev.energy-api-v2/carbon/carbonintensity","routeSlug":"/ev.energy-api-v2/carbon/carbonintensity","httpVerb":"schema"}]},{"type":"group","label":"Charging Sessions","link":"/ev.energy-api-v2/charging-sessions","routeSlug":"/ev.energy-api-v2/charging-sessions","items":[{"label":"List charging sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sessions","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sessions","metadata":{"seo":{"title":"List charging sessions","description":"List all charging sessions visible to the authenticated client. Each session represents one physical plug-in episode: its start/end are the plug-in and unplug times. A session contains one or more charging sub-sessions — one per contiguous period in a single charging mode."}},"httpPath":"/charging_sessions"},{"label":"Retrieve a charging session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sessions-charging_session_id","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sessions-charging_session_id","metadata":{"seo":{"title":"Retrieve a charging session","description":"Retrieve a specific charging session representing one physical plug-in episode: its start/end are the plug-in and unplug times. See Understanding charging data."}},"httpPath":"/charging_sessions/{charging_session_id}"},{"label":"Start boost charging","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/post-charging_sessions-charging_session_id-boost_start","routeSlug":"/ev.energy-api-v2/charging-sessions/post-charging_sessions-charging_session_id-boost_start","metadata":{"seo":{"title":"Start boost charging","description":"Start boost charging on this charging session's vehicle. Finishes thein-progress smart charging sub-session and starts a replacement boostsub-session, charging the vehicle continuously rather than around thecheapest/greenest times. The plug-in episode (this resource) continuesunchanged."}},"httpPath":"/charging_sessions/{charging_session_id}/boost_start"},{"label":"End boost charging","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/post-charging_sessions-charging_session_id-boost_end","routeSlug":"/ev.energy-api-v2/charging-sessions/post-charging_sessions-charging_session_id-boost_end","metadata":{"seo":{"title":"End boost charging","description":"End boost charging on this charging session's vehicle. Finishes thein-progress boost sub-session and starts a replacement smart chargingsub-session, returning the vehicle to charging around thecheapest/greenest times. The plug-in episode (this resource) continuesunchanged."}},"httpPath":"/charging_sessions/{charging_session_id}/boost_end"},{"label":"List charging sub sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions","metadata":{"seo":{"title":"List charging sub sessions","description":"List all charging sub sessions visible to the authenticated client."}},"httpPath":"/charging_sub_sessions"},{"label":"Retrieve a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id","metadata":{"seo":{"title":"Retrieve a charging sub-session","description":"Retrieve a specific charging sub-session, representing a period of a plug-in episode during which a single charging mode was active. Its start/end mark when the mode started and stopped being active — not plug-in/plug-out times, and not when energy was actually flowing. See Understanding charging data."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}"},{"label":"Retrieve periodic energy usage intervals for a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-energy_usage","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-energy_usage","metadata":{"seo":{"title":"Retrieve periodic energy usage intervals for a charging sub-session","description":"Retrieve periodic energy usage intervals for a specific charging sub-session. This is the endpoint to use to find out when energy was actually delivered to the vehicle."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/energy_usage"},{"label":"Retrieve flags for a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-flags","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-flags","metadata":{"seo":{"title":"Retrieve flags for a charging sub-session","description":"Retrieve flags associated with a specific charging sub-session."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/flags"},{"label":"Retrieve debug metadata for a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-debug_metadata","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-debug_metadata","metadata":{"seo":{"title":"Retrieve debug metadata for a charging sub-session","description":"Retrieve debug metadata for a specific charging sub-session."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/debug_metadata"},{"label":"Retrieve schedules for a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-schedules","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-schedules","metadata":{"seo":{"title":"Retrieve schedules for a charging sub-session","description":"Retrieve schedules for a specific charging sub-session."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/schedules"},{"label":"Retrieve schedule plans for a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-schedule_plans","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-schedule_plans","metadata":{"seo":{"title":"Retrieve schedule plans for a charging sub-session","description":"Retrieve schedule plans for a specific charging sub-session."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/schedule_plans"},{"label":"Retrieve assessment for a charging sub-session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-assessment","routeSlug":"/ev.energy-api-v2/charging-sessions/get-charging_sub_sessions-charging_sub_session_id-assessment","metadata":{"seo":{"title":"Retrieve assessment for a charging sub-session","description":"Retrieve the performance assessment for a specific charging sub-session."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/assessment"},{"label":"Recalculate energy usages for a charging sub-session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/post-charging_sub_sessions-charging_sub_session_id-recalculate_energy_usages","routeSlug":"/ev.energy-api-v2/charging-sessions/post-charging_sub_sessions-charging_sub_session_id-recalculate_energy_usages","metadata":{"seo":{"title":"Recalculate energy usages for a charging sub-session","description":"Triggers a recalculation of energy usages (and performance assessment) for a completedcharging sub-session. Use dry_run to preview the recalculation without persistingchanges, and cap_overages to control whether energy overages are capped."}},"httpPath":"/charging_sub_sessions/{charging_sub_session_id}/recalculate_energy_usages"},{"label":"List dispatcher logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/charging-sessions/get-dispatcher_logs","routeSlug":"/ev.energy-api-v2/charging-sessions/get-dispatcher_logs","metadata":{"seo":{"title":"List dispatcher logs","description":"List all dispatcher logs for a charging session. These logs record Dispatch Command attempts to EVSEs or Vehicles."}},"httpPath":"/dispatcher_logs"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Charging sub-session created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/ev.energy-api-v2/charging-sessions/paths/charging_sub_session.created/post","routeSlug":"/ev.energy-api-v2/charging-sessions/paths/charging_sub_session.created/post","metadata":{"seo":{"title":"Charging sub-session created","description":"A charging sub-session is created, representing a period of charging in a single mode."}},"httpPath":"charging_sub_session.created"},{"label":"Charging sub-session ended","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/ev.energy-api-v2/charging-sessions/paths/charging_sub_session.ended/post","routeSlug":"/ev.energy-api-v2/charging-sessions/paths/charging_sub_session.ended/post","metadata":{"seo":{"title":"Charging sub-session ended","description":"A charging sub-session has ended, representing a period of charging in a single mode."}},"httpPath":"charging_sub_session.ended"},{"type":"link","label":"DispatcherLog","link":"/ev.energy-api-v2/charging-sessions/dispatcherlog","routeSlug":"/ev.energy-api-v2/charging-sessions/dispatcherlog","httpVerb":"schema"}]},{"type":"group","label":"CSV","link":"/ev.energy-api-v2/csv","routeSlug":"/ev.energy-api-v2/csv","items":[]},{"type":"group","label":"EVSEs","link":"/ev.energy-api-v2/evses","routeSlug":"/ev.energy-api-v2/evses","items":[{"label":"Check EVSE model compatibility in a country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_compatibility-check","routeSlug":"/ev.energy-api-v2/evses/get-evse_compatibility-check","metadata":{"seo":{"title":"Check EVSE model compatibility in a country","description":"Returns whether the given EVSEModel is supported in the suppliedcountry, and whether the support is beta (early-access) or live.Used by the onboarding flow to tell the user upfront whether theirhardware will work before any account-linking step."}},"httpPath":"/evse_compatibility/check"},{"label":"List EVSEs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses","routeSlug":"/ev.energy-api-v2/evses/get-evses","metadata":{"seo":{"title":"List EVSEs","description":"List all the EVSEs that the authorization token has access to."}},"httpPath":"/evses"},{"label":"Retrieve an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id","metadata":{"seo":{"title":"Retrieve an EVSE","description":"Retrieve a single, specific EVSE's details."}},"httpPath":"/evses/{evse_id}"},{"label":"Update an EVSE","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/patch-evses-evse_id","routeSlug":"/ev.energy-api-v2/evses/patch-evses-evse_id","metadata":{"seo":{"title":"Update an EVSE","description":"Update an EVSE. Only the EVSE's location may be changed via this endpoint; all other fields are read-only."}},"httpPath":"/evses/{evse_id}"},{"label":"Decommission an EVSE","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/delete-evses-evse_id","routeSlug":"/ev.energy-api-v2/evses/delete-evses-evse_id","metadata":{"seo":{"title":"Decommission an EVSE","description":"Decommission the EVSE by disconnecting it from the ev.energy system."}},"httpPath":"/evses/{evse_id}"},{"label":"List EVSE models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_models","routeSlug":"/ev.energy-api-v2/evses/get-evse_models","metadata":{"seo":{"title":"List EVSE models","description":"List all the EVSE models known by the ev.energy system."}},"httpPath":"/evse_models"},{"label":"Retrieve an EVSE model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_models-evse_model_id","routeSlug":"/ev.energy-api-v2/evses/get-evse_models-evse_model_id","metadata":{"seo":{"title":"Retrieve an EVSE model","description":"Retrieve details for a single, specific EVSE model."}},"httpPath":"/evse_models/{evse_model_id}"},{"label":"List EVSE makes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_makes","routeSlug":"/ev.energy-api-v2/evses/get-evse_makes","metadata":{"seo":{"title":"List EVSE makes","description":"List all the EVSE makes known by the ev.energy system."}},"httpPath":"/evse_makes"},{"label":"Retrieve an EVSE make","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_makes-evse_make_id","routeSlug":"/ev.energy-api-v2/evses/get-evse_makes-evse_make_id","metadata":{"seo":{"title":"Retrieve an EVSE make","description":"Retrieve details for a single, specific EVSE make."}},"httpPath":"/evse_makes/{evse_make_id}"},{"label":"List status logs for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-status_logs","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-status_logs","metadata":{"seo":{"title":"List status logs for an EVSE","description":"List the historical status logs for a specific EVSE. Used to find out the state of the EVSE at each point it reported in to ev.energy."}},"httpPath":"/evses/{evse_id}/status_logs"},{"label":"Retrieve a status log for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-status_logs-timestamp","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-status_logs-timestamp","metadata":{"seo":{"title":"Retrieve a status log for an EVSE","description":"An EVSE status log is uniquely identified by the combination of EVSE ID and the time it was sampled at."}},"httpPath":"/evses/{evse_id}/status_logs/{sampled_at}"},{"label":"List command logs for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-command_logs","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-command_logs","metadata":{"seo":{"title":"List command logs for an EVSE","description":"List the historical command logs for a specific EVSE. These logs record commands that were sent to the EVSE."}},"httpPath":"/evses/{evse_id}/command_logs"},{"label":"Retrieve a command log for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-command_logs-timestamp","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-command_logs-timestamp","metadata":{"seo":{"title":"Retrieve a command log for an EVSE","description":"An EVSE command log is uniquely identified by the combination of EVSE ID and the time it was logged at."}},"httpPath":"/evses/{evse_id}/command_logs/{logged_at}"},{"label":"List API error logs for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-error_logs","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-error_logs","metadata":{"seo":{"title":"List API error logs for an EVSE","description":"List the historical API error logs for a specific EVSE. These logs capture errors that occurred when attempting to communicate with the EVSE's hardware API."}},"httpPath":"/evses/{evse_id}/error_logs"},{"label":"Retrieve a specific API error log for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-error_logs-timestamp","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-error_logs-timestamp","metadata":{"seo":{"title":"Retrieve a specific API error log for an EVSE","description":"A single API error log for a particular EVSE is uniquely identified by the timestamp it was sampled at."}},"httpPath":"/evses/{evse_id}/error_logs/{sampled_at}"},{"label":"List OCPP logs for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-ocpp_logs","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-ocpp_logs","metadata":{"seo":{"title":"List OCPP logs for an EVSE","description":"List the historical OCPP message logs for a specific EVSE. These logs record OCPP messages sent to or received from the charger."}},"httpPath":"/evses/{evse_id}/ocpp_logs"},{"label":"Retrieve an OCPP log for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-ocpp_logs-timestamp","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-ocpp_logs-timestamp","metadata":{"seo":{"title":"Retrieve an OCPP log for an EVSE","description":"An EVSE OCPP log is uniquely identified by the combination of EVSE ID and the time it was sampled at."}},"httpPath":"/evses/{evse_id}/ocpp_logs/{sampled_at}"},{"label":"Get VPP modes for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-vpp_modes","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-vpp_modes","metadata":{"seo":{"title":"Get VPP modes for an EVSE","description":"Returns the VPP (Virtual Power Plant) control modes supported by this EVSE."}},"httpPath":"/evses/{evse_id}/vpp_modes"},{"label":"Get connectivity information for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evses-evse_id-connectivity","routeSlug":"/ev.energy-api-v2/evses/get-evses-evse_id-connectivity","metadata":{"seo":{"title":"Get connectivity information for an EVSE","description":"Returns a snapshot of the EVSE's connectivity metrics including signal strength, SIM data, firmware version, and connection reliability."}},"httpPath":"/evses/{evse_id}/connectivity"},{"label":"Create EVSE reconnection URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/post-evses-evse_id-reconnect","routeSlug":"/ev.energy-api-v2/evses/post-evses-evse_id-reconnect","metadata":{"seo":{"title":"Create EVSE reconnection URL","description":"Create a reconnection request URL for the EVSE. The EVSE must have a user assigned."}},"httpPath":"/evses/{evse_id}/reconnect"},{"label":"List EVSE firmware versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_firmware_versions","routeSlug":"/ev.energy-api-v2/evses/get-evse_firmware_versions","metadata":{"seo":{"title":"List EVSE firmware versions","description":"List EVSE firmware versions available in the catalogue. Only firmware versions flagged as production releases are returned."}},"httpPath":"/evse_firmware_versions"},{"label":"Retrieve an EVSE firmware version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_firmware_versions-evse_firmware_version_id","routeSlug":"/ev.energy-api-v2/evses/get-evse_firmware_versions-evse_firmware_version_id","metadata":{"seo":{"title":"Retrieve an EVSE firmware version","description":"Retrieve a single EVSE firmware version by ID."}},"httpPath":"/evse_firmware_versions/{evse_firmware_version_id}"},{"label":"Initiate EVSE onboarding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/get-evse_onboarding","routeSlug":"/ev.energy-api-v2/evses/get-evse_onboarding","metadata":{"seo":{"title":"Initiate EVSE onboarding","description":"Initiate the onboarding process for a new EVSE in your user's browser (or an embedded web view in an app)."}},"httpPath":"/evse_onboarding"},{"label":"Import an EVSE by serial number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/post-evse_onboarding-import","routeSlug":"/ev.energy-api-v2/evses/post-evse_onboarding-import","metadata":{"seo":{"title":"Import an EVSE by serial number","description":"Import an EVSE into the ev.energy system using its serial number and the authenticated user's email. The backend calls the provider's API to look up the device and link it; the response is the freshly created EVSE resource, shape-identical to GET /evses/{evse_id}."}},"httpPath":"/evse_onboarding/import"},{"label":"Add user to the EVSE waitlist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/evses/post-evse_waitlist","routeSlug":"/ev.energy-api-v2/evses/post-evse_waitlist","metadata":{"seo":{"title":"Add user to the EVSE waitlist","description":"Captures a user who hit an incompatible result on the EVSE compatibility check, so we can notify them once their hardware becomes supported. Pre-account, anonymous endpoint — no OAuth token required."}},"httpPath":"/evse_waitlist"},{"type":"link","label":"EVSE","link":"/ev.energy-api-v2/evses/evse","routeSlug":"/ev.energy-api-v2/evses/evse","httpVerb":"schema"},{"type":"link","label":"EVSEAPIErrorLog","link":"/ev.energy-api-v2/evses/evseapierrorlog","routeSlug":"/ev.energy-api-v2/evses/evseapierrorlog","httpVerb":"schema"},{"type":"link","label":"EVSECommandLog","link":"/ev.energy-api-v2/evses/evsecommandlog","routeSlug":"/ev.energy-api-v2/evses/evsecommandlog","httpVerb":"schema"},{"type":"link","label":"EVSEImportRequest","link":"/ev.energy-api-v2/evses/evseimportrequest","routeSlug":"/ev.energy-api-v2/evses/evseimportrequest","httpVerb":"schema"},{"type":"link","label":"Make","link":"/ev.energy-api-v2/evses/evsemake","routeSlug":"/ev.energy-api-v2/evses/evsemake","httpVerb":"schema"},{"type":"link","label":"Model","link":"/ev.energy-api-v2/evses/evsemodel","routeSlug":"/ev.energy-api-v2/evses/evsemodel","httpVerb":"schema"},{"type":"link","label":"EVSEOCPPLog","link":"/ev.energy-api-v2/evses/evseocpplog","routeSlug":"/ev.energy-api-v2/evses/evseocpplog","httpVerb":"schema"},{"type":"link","label":"EVSEOnboardingJsonResponse","link":"/ev.energy-api-v2/evses/evseonboardingjsonresponse","routeSlug":"/ev.energy-api-v2/evses/evseonboardingjsonresponse","httpVerb":"schema"},{"type":"link","label":"EVSEStatusLog","link":"/ev.energy-api-v2/evses/evsestatuslog","routeSlug":"/ev.energy-api-v2/evses/evsestatuslog","httpVerb":"schema"},{"type":"link","label":"EVSEWaitlistRequest","link":"/ev.energy-api-v2/evses/evsewaitlistrequest","routeSlug":"/ev.energy-api-v2/evses/evsewaitlistrequest","httpVerb":"schema"},{"type":"link","label":"EVSEWaitlistResponse","link":"/ev.energy-api-v2/evses/evsewaitlistresponse","routeSlug":"/ev.energy-api-v2/evses/evsewaitlistresponse","httpVerb":"schema"}]},{"type":"group","label":"Home Batteries","link":"/ev.energy-api-v2/home-batteries","routeSlug":"/ev.energy-api-v2/home-batteries","items":[{"label":"List home battery makes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_battery_makes","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_battery_makes","metadata":{"seo":{"title":"List home battery makes","description":"List all the home battery makes known by the ev.energy system."}},"httpPath":"/home_battery_makes"},{"label":"Retrieve a home battery make","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_battery_makes-home_battery_make_id","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_battery_makes-home_battery_make_id","metadata":{"seo":{"title":"Retrieve a home battery make","description":"Retrieve details for a single, specific home battery make."}},"httpPath":"/home_battery_makes/{home_battery_make_id}"},{"label":"List home battery models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_battery_models","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_battery_models","metadata":{"seo":{"title":"List home battery models","description":"List all the home battery models known by the ev.energy system."}},"httpPath":"/home_battery_models"},{"label":"Retrieve a home battery model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_battery_models-home_battery_model_id","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_battery_models-home_battery_model_id","metadata":{"seo":{"title":"Retrieve a home battery model","description":"Retrieve details for a single, specific home battery model."}},"httpPath":"/home_battery_models/{home_battery_model_id}"},{"label":"List home batteries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_batteries","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_batteries","metadata":{"seo":{"title":"List home batteries","description":"List all the home batteries that the authorization token has access to."}},"httpPath":"/home_batteries"},{"label":"Retrieve a home battery","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_batteries-home_battery_id","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_batteries-home_battery_id","metadata":{"seo":{"title":"Retrieve a home battery","description":"Retrieve a single, specific home battery's details."}},"httpPath":"/home_batteries/{home_battery_id}"},{"label":"List status logs for a home battery","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_batteries-home_battery_id-status_logs","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_batteries-home_battery_id-status_logs","metadata":{"seo":{"title":"List status logs for a home battery","description":"List the historical status logs for a specific home battery. Used to find out the state of the battery at each point it reported in to ev.energy."}},"httpPath":"/home_batteries/{home_battery_id}/status_logs"},{"label":"Retrieve a status log for a home battery","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/home-batteries/get-home_batteries-home_battery_id-status_logs-timestamp","routeSlug":"/ev.energy-api-v2/home-batteries/get-home_batteries-home_battery_id-status_logs-timestamp","metadata":{"seo":{"title":"Retrieve a status log for a home battery","description":"A home battery status log is uniquely identified by the combination of home battery ID and the time it was sampled at."}},"httpPath":"/home_batteries/{home_battery_id}/status_logs/{sampled_at}"},{"type":"link","label":"HomeBattery","link":"/ev.energy-api-v2/home-batteries/homebattery","routeSlug":"/ev.energy-api-v2/home-batteries/homebattery","httpVerb":"schema"},{"type":"link","label":"HomeBatteryMake","link":"/ev.energy-api-v2/home-batteries/homebatterymake","routeSlug":"/ev.energy-api-v2/home-batteries/homebatterymake","httpVerb":"schema"},{"type":"link","label":"HomeBatteryModel","link":"/ev.energy-api-v2/home-batteries/homebatterymodel","routeSlug":"/ev.energy-api-v2/home-batteries/homebatterymodel","httpVerb":"schema"},{"type":"link","label":"HomeBatteryStatusLog","link":"/ev.energy-api-v2/home-batteries/homebatterystatuslog","routeSlug":"/ev.energy-api-v2/home-batteries/homebatterystatuslog","httpVerb":"schema"}]},{"type":"group","label":"Notifications","link":"/ev.energy-api-v2/notifications","routeSlug":"/ev.energy-api-v2/notifications","items":[{"label":"List notifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/notifications/get-notifications","routeSlug":"/ev.energy-api-v2/notifications/get-notifications","metadata":{"seo":{"title":"List notifications","description":"Lists notifications for the user making the request. For each notification it returns a category (INFO, ERROR etc) and a title (in the user's language) for display in their inbox."}},"httpPath":"/notifications"},{"label":"Update a notification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/notifications/patch-notifications-notification_id","routeSlug":"/ev.energy-api-v2/notifications/patch-notifications-notification_id","metadata":{"seo":{"title":"Update a notification","description":"Update a notification."}},"httpPath":"/notifications/{notification_id}"},{"label":"Retrieve a notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/notifications/get-notifications-notification_id","routeSlug":"/ev.energy-api-v2/notifications/get-notifications-notification_id","metadata":{"seo":{"title":"Retrieve a notification","description":"Retrieves the full details of a specified notification. The title,short_text and long_text fields will be translated into the user'slanguage."}},"httpPath":"/notifications/{notification_id}"}]},{"type":"group","label":"Programs","link":"/ev.energy-api-v2/programs","routeSlug":"/ev.energy-api-v2/programs","items":[{"label":"List vehicle compatibility for a program","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id-vehicle_compatibility","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id-vehicle_compatibility","metadata":{"seo":{"title":"List vehicle compatibility for a program","description":"List vehicle compatibility records for a specific program."}},"httpPath":"/programs/{program_id}/vehicle_compatibility"},{"label":"List programs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs","routeSlug":"/ev.energy-api-v2/programs/get-programs","metadata":{"seo":{"title":"List programs","description":"By default, this endpoint returns all programs in our system and does not require authentication. The coordinates, postal_code and country_code query parameters can be used to narrow the list down to just programs eligible for particular locations. Coordinates and postal code searching are mutually exclusive and mixing the query parameters will result in a 400 error response."}},"httpPath":"/programs"},{"label":"Retrieve a program","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id","metadata":{"seo":{"title":"Retrieve a program","description":"Retrieve details for a single, specific program."}},"httpPath":"/programs/{program_id}"},{"label":"List incentive schemes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-incentive_schemes","routeSlug":"/ev.energy-api-v2/programs/get-incentive_schemes","metadata":{"seo":{"title":"List incentive schemes","description":"Returns a list of Incentive Schemes that the authenticated User is eligble for."}},"httpPath":"/incentive_schemes"},{"label":"Verify user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/post-programs-user-verification","routeSlug":"/ev.energy-api-v2/programs/post-programs-user-verification","metadata":{"seo":{"title":"Verify user","description":"Upload a user's utility account information for verification and account matching against the utility's customer data."}},"httpPath":"/programs/{program_id}/user_verification"},{"label":"Join program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/post-programs-program_id-join","routeSlug":"/ev.energy-api-v2/programs/post-programs-program_id-join","metadata":{"seo":{"title":"Join program","description":"Enrol the authenticated user in this program's default tier."}},"httpPath":"/programs/{program_id}/join"},{"label":"List program tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id-tiers","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id-tiers","metadata":{"seo":{"title":"List program tiers","description":"List all selectable tiers under the given Program. Public read-only — noauthentication required. When the request is authenticated as a specificuser (Authorization Code grant, or Client Credentials with EvEnergy-User),each tier's eligible field is populated with the user's eligibility result.Anonymous or pure client-credentials requests receive eligible: null."}},"httpPath":"/programs/{program_id}/tiers"},{"label":"Retrieve a program tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id-tiers-tier_id","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id-tiers-tier_id","metadata":{"seo":{"title":"Retrieve a program tier","description":"Retrieve a single tier nested under a Program. Public read-only. Theeligible field is per-user (see the list endpoint description)."}},"httpPath":"/programs/{program_id}/tiers/{tier_id}"},{"label":"List participation agreement versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id-participation_agreement_versions","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id-participation_agreement_versions","metadata":{"seo":{"title":"List participation agreement versions","description":"List versions of the Participation Agreement attached to the given Program.Public read-only — no authentication required. Fetch the single currentlyactive version from the current sub-resource."}},"httpPath":"/programs/{program_id}/participation_agreement_versions"},{"label":"Retrieve a participation agreement version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id-participation_agreement_versions-id","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id-participation_agreement_versions-id","metadata":{"seo":{"title":"Retrieve a participation agreement version","description":"Retrieve a single Participation Agreement Version nested under a Program. Public read-only."}},"httpPath":"/programs/{program_id}/participation_agreement_versions/{participation_agreement_version_id}"},{"label":"Retrieve the currently active participation agreement version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/get-programs-program_id-participation_agreement_versions-current","routeSlug":"/ev.energy-api-v2/programs/get-programs-program_id-participation_agreement_versions-current","metadata":{"seo":{"title":"Retrieve the currently active participation agreement version","description":"Retrieve the currently active Participation Agreement Version — thehighest-numbered published version of the Program's agreement. currentis a magic value used in place of a version UID."}},"httpPath":"/programs/{program_id}/participation_agreement_versions/current"},{"label":"Accept a participation agreement version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/post-programs-program_id-participation_agreement_versions-id-accept","routeSlug":"/ev.energy-api-v2/programs/post-programs-program_id-participation_agreement_versions-id-accept","metadata":{"seo":{"title":"Accept a participation agreement version","description":"Record that the authenticated user has accepted the given ParticipationAgreement Version, identified by its UID (e.g. the id returned by thecurrent sub-resource)."}},"httpPath":"/programs/{program_id}/participation_agreement_versions/{participation_agreement_version_id}/accept"},{"label":"Post-enrollment verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/programs/post-programs-post-enrollment-verification","routeSlug":"/ev.energy-api-v2/programs/post-programs-post-enrollment-verification","metadata":{"seo":{"title":"Post-enrollment verification","description":"Upload a user's post-enrollment verification data for account verification."}},"httpPath":"/programs/{program_id}/post-enrollment-verification"}]},{"type":"group","label":"Rebates","link":"/ev.energy-api-v2/rebates","routeSlug":"/ev.energy-api-v2/rebates","items":[{"label":"List Rebate Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-rebate_types","routeSlug":"/ev.energy-api-v2/rebates/get-rebate_types","metadata":{"seo":{"title":"List Rebate Types","description":"Retrieve a list of rebate types available to the user."}},"httpPath":"/rebate_types"},{"label":"Retrieve rebate type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-rebate_types-rebate_type_id","routeSlug":"/ev.energy-api-v2/rebates/get-rebate_types-rebate_type_id","metadata":{"seo":{"title":"Retrieve rebate type","description":"Retrieve a specific rebate type by id."}},"httpPath":"/rebate_types/{rebate_type_id}"},{"label":"List Rebate Evidence Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-rebate_evidence_types","routeSlug":"/ev.energy-api-v2/rebates/get-rebate_evidence_types","metadata":{"seo":{"title":"List Rebate Evidence Types","description":"Retrieve a list of rebate types available to the user."}},"httpPath":"/rebate_evidence_types"},{"label":"Retrieve rebate evidence type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-rebate_types-rebate_evidence_type_id","routeSlug":"/ev.energy-api-v2/rebates/get-rebate_types-rebate_evidence_type_id","metadata":{"seo":{"title":"Retrieve rebate evidence type","description":"Retrieve a specific rebate evidence type by id."}},"httpPath":"/rebate_evidence_types/{rebate_evidence_type_id}"},{"label":"Create rebate application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/post-rebates","routeSlug":"/ev.energy-api-v2/rebates/post-rebates","metadata":{"seo":{"title":"Create rebate application","description":"Creates a rebate application, returning the application ID."}},"httpPath":"/user_rebates"},{"label":"List rebate applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-rebates","routeSlug":"/ev.energy-api-v2/rebates/get-rebates","metadata":{"seo":{"title":"List rebate applications","description":"Lists all a user's rebate applications."}},"httpPath":"/user_rebates"},{"label":"Retrieve rebate application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-rebates-application_id","routeSlug":"/ev.energy-api-v2/rebates/get-rebates-application_id","metadata":{"seo":{"title":"Retrieve rebate application","description":"Retrieve a specific rebate application."}},"httpPath":"/user_rebates/{user_rebate_id}"},{"label":"Update rebate application","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/patch-user_rebates-application_id","routeSlug":"/ev.energy-api-v2/rebates/patch-user_rebates-application_id","metadata":{"seo":{"title":"Update rebate application","description":"Attach evidence to a rebate application."}},"httpPath":"/user_rebates/{user_rebate_id}"},{"label":"Submit a completed rebate form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/post-user_rebates-application_id-:submit","routeSlug":"/ev.energy-api-v2/rebates/post-user_rebates-application_id-:submit","metadata":{"seo":{"title":"Submit a completed rebate form","description":"Once all evidence data and files have been uploaded, this endpoint is called to submit the rebate application for review by updating the Form status to \"complete\" and the application status to \"pending_review\"."}},"httpPath":"/user_rebates/{user_rebate_id}:submit"},{"label":"Start a file upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/post-rebate-evidence_files:start_upload","routeSlug":"/ev.energy-api-v2/rebates/post-rebate-evidence_files:start_upload","metadata":{"seo":{"title":"Start a file upload","description":"This endpoint creates the RebateEvidenceFile record and returns its uid as well as a presigned URL to use for direct upload to AWS S3."}},"httpPath":"/rebate_evidence_files:start_upload"},{"label":"Finalize File Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/post-rebate-evidence_files-evidence_file_id-:finish_upload","routeSlug":"/ev.energy-api-v2/rebates/post-rebate-evidence_files-evidence_file_id-:finish_upload","metadata":{"seo":{"title":"Finalize File Upload","description":"After the file is successfully uploaded to S3 via the presigned URL, this endpoint is called to set the upload_finished_at timestamp on the evidence_file record."}},"httpPath":"/rebate_evidence_files/{rebate_evidence_file_id}:finish_upload"},{"label":"List rebate evidence files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-user_rebates-application_id-evidence_files","routeSlug":"/ev.energy-api-v2/rebates/get-user_rebates-application_id-evidence_files","metadata":{"seo":{"title":"List rebate evidence files","description":"List all user's rebate evidence files"}},"httpPath":"/rebate_evidence_files"},{"label":"Retrieve rebate evidence file details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/rebates/get-user_rebates-application_id-evidence_files-evidence_file_id","routeSlug":"/ev.energy-api-v2/rebates/get-user_rebates-application_id-evidence_files-evidence_file_id","metadata":{"seo":{"title":"Retrieve rebate evidence file details","description":"Retrieve the details of a specific rebate evidence file."}},"httpPath":"/rebate_evidence_files/{rebate_evidence_file_id}"},{"type":"link","label":"UserRebateCreated","link":"/ev.energy-api-v2/rebates/userrebatecreated","routeSlug":"/ev.energy-api-v2/rebates/userrebatecreated","httpVerb":"schema"}]},{"type":"group","label":"Referral Codes","link":"/ev.energy-api-v2/referral-codes","routeSlug":"/ev.energy-api-v2/referral-codes","items":[{"label":"List referral codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/referral-codes/get-referral_codes","routeSlug":"/ev.energy-api-v2/referral-codes/get-referral_codes","metadata":{"seo":{"title":"List referral codes","description":"List the referral/promo codes owned by the caller's organisation, each with its redemption counts broken down by stage."}},"httpPath":"/referral_codes"},{"label":"Mint a referral code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/referral-codes/post-referral_codes","routeSlug":"/ev.energy-api-v2/referral-codes/post-referral_codes","metadata":{"seo":{"title":"Mint a referral code","description":"Mint a referral/promo code owned by the caller's organisation."}},"httpPath":"/referral_codes"},{"label":"Retrieve a referral code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/referral-codes/get-referral_codes-referral_code_id","routeSlug":"/ev.energy-api-v2/referral-codes/get-referral_codes-referral_code_id","metadata":{"seo":{"title":"Retrieve a referral code","description":"Retrieve one of the caller organisation's referral codes."}},"httpPath":"/referral_codes/{referral_code_id}"},{"label":"Update a referral code","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/referral-codes/patch-referral_codes-referral_code_id","routeSlug":"/ev.energy-api-v2/referral-codes/patch-referral_codes-referral_code_id","metadata":{"seo":{"title":"Update a referral code","description":"Update a referral code's label, campaign_ref or status."}},"httpPath":"/referral_codes/{referral_code_id}"},{"label":"List referral code redemptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/referral-codes/get-referral_code_redemptions","routeSlug":"/ev.energy-api-v2/referral-codes/get-referral_code_redemptions","metadata":{"seo":{"title":"List referral code redemptions","description":"The per-redemption ledger for the caller organisation's codes, with the stageeach redemption has reached."}},"httpPath":"/referral_code_redemptions"},{"label":"Retrieve a referral code redemption","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/referral-codes/get-referral_code_redemptions-redemption_id","routeSlug":"/ev.energy-api-v2/referral-codes/get-referral_code_redemptions-redemption_id","metadata":{"seo":{"title":"Retrieve a referral code redemption","description":"Retrieve a single anonymised redemption row for one of the caller organisation's codes."}},"httpPath":"/referral_code_redemptions/{redemption_id}"}]},{"type":"group","label":"Regions","link":"/ev.energy-api-v2/regions","routeSlug":"/ev.energy-api-v2/regions","items":[{"label":"List regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/get-regions","routeSlug":"/ev.energy-api-v2/regions/get-regions","metadata":{"seo":{"title":"List regions","description":"List the regions created by your organisation (geometry omitted — retrieve a single region for its GeoJSON boundary)."}},"httpPath":"/regions"},{"label":"Create region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/post-regions","routeSlug":"/ev.energy-api-v2/regions/post-regions","metadata":{"seo":{"title":"Create region","description":"Create a single region. The submitted geometries are unioned server-side into one MultiPolygon. Region names are unique across all organisations: a name clash returns 409 with the existing region's URL — there is no upsert, and regions cannot be replaced via the API. The creating application must be linked to an organisation (creation is attributed to it, and only that organisation can read the region afterwards) — otherwise 403. Linked region_groups must belong to your organisation."}},"httpPath":"/regions"},{"label":"Retrieve region","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/get-regions-region_id","routeSlug":"/ev.energy-api-v2/regions/get-regions-region_id","metadata":{"seo":{"title":"Retrieve region","description":"Retrieve a single region created by your organisation, including its full GeoJSON MultiPolygon geometry."}},"httpPath":"/regions/{region_id}"},{"label":"List region groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/get-region_groups","routeSlug":"/ev.energy-api-v2/regions/get-region_groups","metadata":{"seo":{"title":"List region groups","description":"List the region groups created by your organisation."}},"httpPath":"/region_groups"},{"label":"Create region group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/post-region_groups","routeSlug":"/ev.energy-api-v2/regions/post-region_groups","metadata":{"seo":{"title":"Create region group","description":"Atomically create a region group together with its member regions. Names are unique across all organisations, and every submitted region name must be fresh — a clash with an existing region always fails the whole request with 409; regions are never replaced or linked. Any failure rolls the whole request back — nothing is partially written. Send the identical body to POST /region_groups:validate first for a zero-write preview. The creating application must be linked to an organisation (creation is attributed to it, and only that organisation can read the group and regions afterwards) — otherwise 403."}},"httpPath":"/region_groups"},{"label":"Retrieve region group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/get-region_groups-region_group_id","routeSlug":"/ev.energy-api-v2/regions/get-region_groups-region_group_id","metadata":{"seo":{"title":"Retrieve region group","description":"Retrieve region group"}},"httpPath":"/region_groups/{region_group_id}"},{"label":"Validate a region group upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/regions/post-region_groups:validate","routeSlug":"/ev.energy-api-v2/regions/post-region_groups:validate","metadata":{"seo":{"title":"Validate a region group upload","description":"Zero-write dry-run of POST /region_groups with the identical body. Always returns 200 for content findings (name clashes, invalid geometry, duplicate names) — the findings ARE the response. Clashing entries include the existing region's URL; renaming the submitted region is the only resolution — regions are never replaced or linked."}},"httpPath":"/region_groups:validate"}]},{"type":"group","label":"Root","link":"/ev.energy-api-v2/root","routeSlug":"/ev.energy-api-v2/root","items":[{"label":"API root","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/root/get-root","routeSlug":"/ev.energy-api-v2/root/get-root","metadata":{"seo":{"title":"API root","description":"Get links to resources accessible in the API."}},"httpPath":"/"}]},{"type":"group","label":"Schedules","link":"/ev.energy-api-v2/schedules","routeSlug":"/ev.energy-api-v2/schedules","items":[{"type":"link","label":"ScheduleInterval","link":"/ev.energy-api-v2/schedules/scheduleinterval","routeSlug":"/ev.energy-api-v2/schedules/scheduleinterval","httpVerb":"schema"}]},{"type":"group","label":"Sites","link":"/ev.energy-api-v2/sites","routeSlug":"/ev.energy-api-v2/sites","items":[{"label":"List EVSE Sites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/sites/get-evse_sites","routeSlug":"/ev.energy-api-v2/sites/get-evse_sites","metadata":{"seo":{"title":"List EVSE Sites","description":"List all available EVSE Sites"}},"httpPath":"/evse_sites"},{"label":"Retrieve an EVSE Site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/sites/get-evse_sites-evse_site_id","routeSlug":"/ev.energy-api-v2/sites/get-evse_sites-evse_site_id","metadata":{"seo":{"title":"Retrieve an EVSE Site","description":"Retrieve a single, specific EVSESite's details."}},"httpPath":"/evse_sites/{evse_site_id}"},{"label":"List CPMS Providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/sites/get-cpms_providers","routeSlug":"/ev.energy-api-v2/sites/get-cpms_providers","metadata":{"seo":{"title":"List CPMS Providers","description":"Get a list of all the ChargePoint Management System Providers that we integrate with."}},"httpPath":"/cpms_providers"},{"label":"Retrieve a CPMS Provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/sites/get-cpms_providers-provider_id","routeSlug":"/ev.energy-api-v2/sites/get-cpms_providers-provider_id","metadata":{"seo":{"title":"Retrieve a CPMS Provider","description":"Get details on a single CPMS provider."}},"httpPath":"/cpms_providers/{cpms_provider_id}"}]},{"type":"group","label":"Solar","link":"/ev.energy-api-v2/solar","routeSlug":"/ev.energy-api-v2/solar","items":[{"label":"List solar arrays","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-solar-arrays","routeSlug":"/ev.energy-api-v2/solar/get-solar-arrays","metadata":{"seo":{"title":"List solar arrays","description":"List all the solar arrays that the authorization token has access to."}},"httpPath":"/solar_arrays"},{"label":"Create a solar array","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/post-solar-arrays","routeSlug":"/ev.energy-api-v2/solar/post-solar-arrays","metadata":{"seo":{"title":"Create a solar array","description":"Creates a solar array and associates it with the user."}},"httpPath":"/solar_arrays"},{"label":"Retrieve a solar array","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-solar-arrays-solar_array_id","routeSlug":"/ev.energy-api-v2/solar/get-solar-arrays-solar_array_id","metadata":{"seo":{"title":"Retrieve a solar array","description":"Retrieve a single, specific solar array's details."}},"httpPath":"/solar_arrays/{solar_array_id}"},{"label":"Update a solar array","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/patch-solar_arrays-solar_array_id","routeSlug":"/ev.energy-api-v2/solar/patch-solar_arrays-solar_array_id","metadata":{"seo":{"title":"Update a solar array","description":"Update a solar array."}},"httpPath":"/solar_arrays/{solar_array_id}"},{"label":"Create an Inverter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/post-inverters","routeSlug":"/ev.energy-api-v2/solar/post-inverters","metadata":{"seo":{"title":"Create an Inverter","description":"Creates an Inverter and associates it with a user's solar array."}},"httpPath":"/inverters"},{"label":"List inverters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverters","routeSlug":"/ev.energy-api-v2/solar/get-inverters","metadata":{"seo":{"title":"List inverters","description":"List all the inverters that the authorization token has access to."}},"httpPath":"/inverters"},{"label":"Retrieve an inverter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverters-inverter_id","routeSlug":"/ev.energy-api-v2/solar/get-inverters-inverter_id","metadata":{"seo":{"title":"Retrieve an inverter","description":"Retrieve a single, specific inverter's details."}},"httpPath":"/inverters/{inverter_id}"},{"label":"List inverter makes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverter_makes","routeSlug":"/ev.energy-api-v2/solar/get-inverter_makes","metadata":{"seo":{"title":"List inverter makes","description":"List all the inverter makes known by the ev.energy system."}},"httpPath":"/inverter_makes"},{"label":"Retrieve an inverter make","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverter_makes-inverter_make_id","routeSlug":"/ev.energy-api-v2/solar/get-inverter_makes-inverter_make_id","metadata":{"seo":{"title":"Retrieve an inverter make","description":"Retrieve details for a single, specific EVSE make."}},"httpPath":"/inverter_makes/{inverter_make_id}"},{"label":"List inverter models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverter_models","routeSlug":"/ev.energy-api-v2/solar/get-inverter_models","metadata":{"seo":{"title":"List inverter models","description":"List all the inverter models known by the ev.energy system."}},"httpPath":"/inverter_models"},{"label":"Retrieve an inverter model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverter_models-inverter_model_id","routeSlug":"/ev.energy-api-v2/solar/get-inverter_models-inverter_model_id","metadata":{"seo":{"title":"Retrieve an inverter model","description":"Retrieve details for a single, specific inverter model."}},"httpPath":"/inverter_models/{inverter_model_id}"},{"label":"Allows a user to authenticate with their inverter account.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar/get-inverter_onboarding","routeSlug":"/ev.energy-api-v2/solar/get-inverter_onboarding","metadata":{"seo":{"title":"Allows a user to authenticate with their inverter account.","description":"This endpoint will redirect to a web page that a user can use to login into their inverter account."}},"httpPath":"/inverter_onboarding"}]},{"type":"group","label":"Solar Forecasts","link":"/ev.energy-api-v2/solar-forecasts","routeSlug":"/ev.energy-api-v2/solar-forecasts","items":[{"label":"List solar forecasts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts","routeSlug":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts","metadata":{"seo":{"title":"List solar forecasts","description":"List all the solar forecasts that the authorization token has access to."}},"httpPath":"/solar_forecasts"},{"label":"Retrieve a solar forecast","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts-solar_forecast_id","routeSlug":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts-solar_forecast_id","metadata":{"seo":{"title":"Retrieve a solar forecast","description":"Retrieve a single, specific solar forecast's details."}},"httpPath":"/solar_forecasts/{solar_forecast_id}"},{"label":"List forecast logs for a solar forecast","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts-solar_forecast_id-forecast_logs","routeSlug":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts-solar_forecast_id-forecast_logs","metadata":{"seo":{"title":"List forecast logs for a solar forecast","description":"List the historical forecast logs for a specific solar forecast. These logs record predicted solar energy production at specific times."}},"httpPath":"/solar_forecasts/{solar_forecast_id}/forecast_logs"},{"label":"Retrieve a forecast log for a solar forecast","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts-solar_forecast_id-forecast_logs-valid_period_start","routeSlug":"/ev.energy-api-v2/solar-forecasts/get-solar-forecasts-solar_forecast_id-forecast_logs-valid_period_start","metadata":{"seo":{"title":"Retrieve a forecast log for a solar forecast","description":"A solar forecast log is uniquely identified by the combination of solar forecast ID and the valid period start time."}},"httpPath":"/solar_forecasts/{solar_forecast_id}/forecast_logs/{valid_period_start}"},{"type":"link","label":"SolarForecast","link":"/ev.energy-api-v2/solar-forecasts/solarforecast","routeSlug":"/ev.energy-api-v2/solar-forecasts/solarforecast","httpVerb":"schema"},{"type":"link","label":"SolarForecastLog","link":"/ev.energy-api-v2/solar-forecasts/solarforecastlog","routeSlug":"/ev.energy-api-v2/solar-forecasts/solarforecastlog","httpVerb":"schema"}]},{"type":"group","label":"Subscriptions","link":"/ev.energy-api-v2/subscriptions","routeSlug":"/ev.energy-api-v2/subscriptions","items":[{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/subscriptions/get-subscriptions","routeSlug":"/ev.energy-api-v2/subscriptions/get-subscriptions","metadata":{"seo":{"title":"List subscriptions","description":"List all the valid subscriptions that the authorization token has access to."}},"httpPath":"/subscriptions"},{"label":"Retrieve a subscription offering","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/subscriptions/get-subscription-offerings-offering_id","routeSlug":"/ev.energy-api-v2/subscriptions/get-subscription-offerings-offering_id","metadata":{"seo":{"title":"Retrieve a subscription offering","description":"Retrieve a single, specific subscription offering's details."}},"httpPath":"/subscription_offerings/{offering_id}"}]},{"type":"group","label":"Support Tickets","link":"/ev.energy-api-v2/support-tickets","routeSlug":"/ev.energy-api-v2/support-tickets","items":[{"label":"List support tickets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_tickets","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_tickets","metadata":{"seo":{"title":"List support tickets","description":"List all support tickets that the authorization token has access to."}},"httpPath":"/support_tickets"},{"label":"Retrieve support ticket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_tickets-support_ticket_id","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_tickets-support_ticket_id","metadata":{"seo":{"title":"Retrieve support ticket","description":"Retrieve information about a single, specific support ticket."}},"httpPath":"/support_tickets/{support_ticket_id}"},{"label":"Update support ticket","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/patch-support_tickets-support_ticket_id","routeSlug":"/ev.energy-api-v2/support-tickets/patch-support_tickets-support_ticket_id","metadata":{"seo":{"title":"Update support ticket","description":"Update support ticket categorization."}},"httpPath":"/support_tickets/{support_ticket_id}"},{"label":"List messages for a support ticket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_tickets-support_ticket_id-messages","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_tickets-support_ticket_id-messages","metadata":{"seo":{"title":"List messages for a support ticket","description":"List all messages in a support ticket conversation, ordered by position."}},"httpPath":"/support_tickets/{support_ticket_id}/messages"},{"label":"Retrieve a message for a support ticket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_tickets-support_ticket_id-messages-message_id","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_tickets-support_ticket_id-messages-message_id","metadata":{"seo":{"title":"Retrieve a message for a support ticket","description":"Retrieve a single message from a support ticket conversation."}},"httpPath":"/support_tickets/{support_ticket_id}/messages/{message_id}"},{"label":"Get support ticket categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_tickets-categories","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_tickets-categories","metadata":{"seo":{"title":"Get support ticket categories","description":"Returns all available support ticket categories and subcategories."}},"httpPath":"/support_tickets/categories"},{"label":"Get support ticket Sankey diagram data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-sankey","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-sankey","metadata":{"seo":{"title":"Get support ticket Sankey diagram data","description":"Returns aggregated data for visualizing ticket flow from category to subcategory in a Sankey diagram. Only includes tickets with human-verified categories."}},"httpPath":"/support-ticket-stats/sankey"},{"label":"Get support ticket volume time series","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-volume","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-volume","metadata":{"seo":{"title":"Get support ticket volume time series","description":"Returns time series data showing ticket volume over time. Can be grouped by day, week, or month."}},"httpPath":"/support-ticket-stats/volume"},{"label":"Get support ticket resolution metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-resolution","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-resolution","metadata":{"seo":{"title":"Get support ticket resolution metrics","description":"Returns metrics about ticket resolution including resolution rate, average and median resolution times."}},"httpPath":"/support-ticket-stats/resolution"},{"label":"Get support ticket status breakdown","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-status","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-status","metadata":{"seo":{"title":"Get support ticket status breakdown","description":"Returns the distribution of tickets across different status values."}},"httpPath":"/support-ticket-stats/status"},{"label":"Get support ticket priority breakdown","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-priority","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-priority","metadata":{"seo":{"title":"Get support ticket priority breakdown","description":"Returns the distribution of tickets across different priority values."}},"httpPath":"/support-ticket-stats/priority"},{"label":"Get support ticket source breakdown","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-source","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-source","metadata":{"seo":{"title":"Get support ticket source breakdown","description":"Returns the distribution of tickets across different source values."}},"httpPath":"/support-ticket-stats/source"},{"label":"Get top support ticket categories and subcategories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-top-categories","routeSlug":"/ev.energy-api-v2/support-tickets/get-support_ticket_stats-top-categories","metadata":{"seo":{"title":"Get top support ticket categories and subcategories","description":"Returns the most common categories and subcategories sorted by ticket count. Supports a limit parameter to control the number of results."}},"httpPath":"/support-ticket-stats/top-categories"},{"type":"link","label":"Support Ticket","link":"/ev.energy-api-v2/support-tickets/supportticket","routeSlug":"/ev.energy-api-v2/support-tickets/supportticket","httpVerb":"schema"}]},{"type":"group","label":"Tariffs","link":"/ev.energy-api-v2/tariffs","routeSlug":"/ev.energy-api-v2/tariffs","items":[{"label":"List suppliers, sorted alphabetically by name.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/tariffs/get-suppliers","routeSlug":"/ev.energy-api-v2/tariffs/get-suppliers","metadata":{"seo":{"title":"List suppliers, sorted alphabetically by name.","description":"List all the energy suppliers known by the ev.energy system."}},"httpPath":"/suppliers"},{"label":"Retrieve a supplier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/tariffs/get-suppliers-suppler_id","routeSlug":"/ev.energy-api-v2/tariffs/get-suppliers-suppler_id","metadata":{"seo":{"title":"Retrieve a supplier","description":"Retrieve details for a single, specific energy supplier."}},"httpPath":"/suppliers/{supplier_id}"},{"label":"List tariffs, sorted alphabetically by name.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/tariffs/get-tariffs","routeSlug":"/ev.energy-api-v2/tariffs/get-tariffs","metadata":{"seo":{"title":"List tariffs, sorted alphabetically by name.","description":"List all the energy supplier tariffs known by the ev.energy system."}},"httpPath":"/tariffs"},{"label":"Retrieve a tariff","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/tariffs/get-tariffs-tariff_id","routeSlug":"/ev.energy-api-v2/tariffs/get-tariffs-tariff_id","metadata":{"seo":{"title":"Retrieve a tariff","description":"Retrieve details for a single, specific tariff."}},"httpPath":"/tariffs/{tariff_id}"},{"label":"List prices for a tariff","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/tariffs/get-tariff-prices","routeSlug":"/ev.energy-api-v2/tariffs/get-tariff-prices","metadata":{"seo":{"title":"List prices for a tariff","description":"Returns all prices for the specified tariff. Results are ordered by start time (most recent first)."}},"httpPath":"/tariffs/{tariff_id}/prices"},{"type":"link","label":"DailyPrices","link":"/ev.energy-api-v2/tariffs/dailyprices","routeSlug":"/ev.energy-api-v2/tariffs/dailyprices","httpVerb":"schema"},{"type":"link","label":"Price","link":"/ev.energy-api-v2/tariffs/price","routeSlug":"/ev.energy-api-v2/tariffs/price","httpVerb":"schema"},{"type":"link","label":"PriceSummary","link":"/ev.energy-api-v2/tariffs/pricesummary","routeSlug":"/ev.energy-api-v2/tariffs/pricesummary","httpVerb":"schema"},{"type":"link","label":"Supplier","link":"/ev.energy-api-v2/tariffs/supplier","routeSlug":"/ev.energy-api-v2/tariffs/supplier","httpVerb":"schema"},{"type":"link","label":"Tariff","link":"/ev.energy-api-v2/tariffs/tariff","routeSlug":"/ev.energy-api-v2/tariffs/tariff","httpVerb":"schema"},{"type":"link","label":"TariffBase","link":"/ev.energy-api-v2/tariffs/tariffbase","routeSlug":"/ev.energy-api-v2/tariffs/tariffbase","httpVerb":"schema"},{"type":"link","label":"TariffDetail","link":"/ev.energy-api-v2/tariffs/tariffdetail","routeSlug":"/ev.energy-api-v2/tariffs/tariffdetail","httpVerb":"schema"},{"type":"link","label":"Times","link":"/ev.energy-api-v2/tariffs/times","routeSlug":"/ev.energy-api-v2/tariffs/times","httpVerb":"schema"}]},{"type":"group","label":"Users","link":"/ev.energy-api-v2/users","routeSlug":"/ev.energy-api-v2/users","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users","routeSlug":"/ev.energy-api-v2/users/get-users","metadata":{"seo":{"title":"List users","description":"List all the users that the authorization token has access to."}},"httpPath":"/users"},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/post-users","routeSlug":"/ev.energy-api-v2/users/post-users","metadata":{"seo":{"title":"Create user","description":"Create an individual user in the ev.energy system."}},"httpPath":"/users"},{"label":"Retrieve user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users-user_id","routeSlug":"/ev.energy-api-v2/users/get-users-user_id","metadata":{"seo":{"title":"Retrieve user","description":"Retrieve information about a single, specific user."}},"httpPath":"/users/{user_id}"},{"label":"Update User","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/patch-users-user_id","routeSlug":"/ev.energy-api-v2/users/patch-users-user_id","metadata":{"seo":{"title":"Update User","description":"Update user information. Updating the email of a Clerk-managed user is permitted for client-credentials integrations, but not for authorization-code tokens, because it changes the account's recovery identity."}},"httpPath":"/users/{user_id}"},{"label":"Retrieve user notification preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users-user_id-notification_preferences","routeSlug":"/ev.energy-api-v2/users/get-users-user_id-notification_preferences","metadata":{"seo":{"title":"Retrieve user notification preferences","description":"Retrieve the set of notification groups the user is currently subscribed to."}},"httpPath":"/users/{user_id}/notification_preferences"},{"label":"Update user notification preferences","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/patch-users-user_id-notification_preferences","routeSlug":"/ev.energy-api-v2/users/patch-users-user_id-notification_preferences","metadata":{"seo":{"title":"Update user notification preferences","description":"Update the user's notification group opt-in state."}},"httpPath":"/users/{user_id}/notification_preferences"},{"label":"Retrieve route planner preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users-user_id-route_planner_preferences","routeSlug":"/ev.energy-api-v2/users/get-users-user_id-route_planner_preferences","metadata":{"seo":{"title":"Retrieve route planner preferences","description":"Retrieve the user's EV Route Planner preferences (default vehicle, en-route minimum charger power, and default arrival battery floor)."}},"httpPath":"/users/{user_id}/route_planner_preferences"},{"label":"Update route planner preferences","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/patch-users-user_id-route_planner_preferences","routeSlug":"/ev.energy-api-v2/users/patch-users-user_id-route_planner_preferences","metadata":{"seo":{"title":"Update route planner preferences","description":"Update the user's EV Route Planner preferences."}},"httpPath":"/users/{user_id}/route_planner_preferences"},{"label":"Retrieve payout method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users-user_id-payout-method","routeSlug":"/ev.energy-api-v2/users/get-users-user_id-payout-method","metadata":{"seo":{"title":"Retrieve payout method","description":"Retrieve the user's preferred payout method. Returns null fields when the user has not set up a payout method."}},"httpPath":"/users/{user_id}/payout_method"},{"label":"Update payout method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/patch-users-user_id-payout-method","routeSlug":"/ev.energy-api-v2/users/patch-users-user_id-payout-method","metadata":{"seo":{"title":"Update payout method","description":"Create or update the user's preferred payout method. The request mustalways include receiver_wallet. For PAYPAL and VENMO theclient must also supply receiver (an email or phone respectively).For BILL_CREDITS the receiver must not be supplied — it isderived server-side from the user's linked billing account."}},"httpPath":"/users/{user_id}/payout_method"},{"label":"Delete payout method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/delete-users-user_id-payout-method","routeSlug":"/ev.energy-api-v2/users/delete-users-user_id-payout-method","metadata":{"seo":{"title":"Delete payout method","description":"Clear the user's preferred payout method. The user's storedUserPayoutMethod records are not removed; only thepreferred_payout_method link on the user is cleared. Returns 204even when the user already has no payout method set (no-op)."}},"httpPath":"/users/{user_id}/payout_method"},{"label":"List saved routes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users-user_id-saved_routes","routeSlug":"/ev.energy-api-v2/users/get-users-user_id-saved_routes","metadata":{"seo":{"title":"List saved routes","description":"List the user's saved route-planner routes. A saved route is a reusable\"recipe\" — origin, destination, waypoints and planning preferences — nota stored charging plan; the plan is recalculated on each re-plan."}},"httpPath":"/users/{user_id}/saved_routes"},{"label":"Create a saved route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/post-users-user_id-saved_routes","routeSlug":"/ev.energy-api-v2/users/post-users-user_id-saved_routes","metadata":{"seo":{"title":"Create a saved route","description":"Create a new saved route for the user. The route is owned by the usernamed in the path; id, url, user and created_at are assigned bythe server. last_used_at defaults to now when omitted."}},"httpPath":"/users/{user_id}/saved_routes"},{"label":"Retrieve a saved route","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/get-users-user_id-saved_routes-saved_route_id","routeSlug":"/ev.energy-api-v2/users/get-users-user_id-saved_routes-saved_route_id","metadata":{"seo":{"title":"Retrieve a saved route","description":"Retrieve a saved route"}},"httpPath":"/users/{user_id}/saved_routes/{saved_route_id}"},{"label":"Update a saved route","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/patch-users-user_id-saved_routes-saved_route_id","routeSlug":"/ev.energy-api-v2/users/patch-users-user_id-saved_routes-saved_route_id","metadata":{"seo":{"title":"Update a saved route","description":"Partially update a saved route: rename it, toggle favourite, bumplast_used_at after a re-plan, or edit the endpoints. Only the fieldssupplied are changed."}},"httpPath":"/users/{user_id}/saved_routes/{saved_route_id}"},{"label":"Delete a saved route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/users/delete-users-user_id-saved_routes-saved_route_id","routeSlug":"/ev.energy-api-v2/users/delete-users-user_id-saved_routes-saved_route_id","metadata":{"seo":{"title":"Delete a saved route","description":"Delete a saved route"}},"httpPath":"/users/{user_id}/saved_routes/{saved_route_id}"},{"type":"link","label":"PayoutMethod","link":"/ev.energy-api-v2/users/payoutmethod","routeSlug":"/ev.energy-api-v2/users/payoutmethod","httpVerb":"schema"},{"type":"link","label":"RoutePlannerPreferences","link":"/ev.energy-api-v2/users/routeplannerpreferences","routeSlug":"/ev.energy-api-v2/users/routeplannerpreferences","httpVerb":"schema"},{"type":"link","label":"SavedRoute","link":"/ev.energy-api-v2/users/savedroute","routeSlug":"/ev.energy-api-v2/users/savedroute","httpVerb":"schema"},{"type":"link","label":"User","link":"/ev.energy-api-v2/users/user","routeSlug":"/ev.energy-api-v2/users/user","httpVerb":"schema"},{"type":"link","label":"UserNotificationPreferences","link":"/ev.energy-api-v2/users/usernotificationpreferences","routeSlug":"/ev.energy-api-v2/users/usernotificationpreferences","httpVerb":"schema"}]},{"type":"group","label":"Vehicles","link":"/ev.energy-api-v2/vehicles","routeSlug":"/ev.energy-api-v2/vehicles","items":[{"label":"Retrieve a vehicle's charging connectors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-connectors","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-connectors","metadata":{"seo":{"title":"Retrieve a vehicle's charging connectors","description":"Retrieve the vehicle's DC-fast charging connectors: its native plug andany adapters it carries. native_connector is the per-vehicle value,falling back to the vehicle model's default when not overridden (bothmay be null when not yet known)."}},"httpPath":"/vehicles/{vehicle_id}/connectors"},{"label":"Update a vehicle's charging connectors","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/patch-vehicles-vehicle_id-connectors","routeSlug":"/ev.energy-api-v2/vehicles/patch-vehicles-vehicle_id-connectors","metadata":{"seo":{"title":"Update a vehicle's charging connectors","description":"Update the vehicle's connectors. The body is a partial map: only thekeys you include are changed. Set native_connector to override themodel default for this vehicle, or null to inherit it. adaptorsreplaces the adapter list (send [] to clear); adaptors must bedistinct and must not include the native connector. PATCH {} is avalid no-op."}},"httpPath":"/vehicles/{vehicle_id}/connectors"},{"label":"Retrieve a vehicle's current state of charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-state_of_charge","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-state_of_charge","metadata":{"seo":{"title":"Retrieve a vehicle's current state of charge","description":"Retrieve the vehicle's current battery percentage used to seed routeplans. source indicates where the value came from: MANUAL when thedriver entered it, or CONNECTED when it comes from the vehicle'stelemetry. All fields are null when no value is available."}},"httpPath":"/vehicles/{vehicle_id}/state_of_charge"},{"label":"Update a vehicle's current state of charge","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/patch-vehicles-vehicle_id-state_of_charge","routeSlug":"/ev.energy-api-v2/vehicles/patch-vehicles-vehicle_id-state_of_charge","metadata":{"seo":{"title":"Update a vehicle's current state of charge","description":"Set the vehicle's current battery percentage (Mode-1 manual entry). Thebody is a partial map: PATCH {} is a valid no-op. Sendstate_of_charge_percentage: null to clear it. source is read-only."}},"httpPath":"/vehicles/{vehicle_id}/state_of_charge"},{"label":"List vehicles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles","metadata":{"seo":{"title":"List vehicles","description":"List all the vehicles that the authorization token has access to."}},"httpPath":"/vehicles"},{"label":"Create unintegrated vehicle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicles","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicles","metadata":{"seo":{"title":"Create unintegrated vehicle","description":"If a vehicle cannot be integrated with our system, an \"unintegrated\" vehicle must be created instead to represent it and record important details like battery size."}},"httpPath":"/vehicles"},{"label":"Retrieve a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id","metadata":{"seo":{"title":"Retrieve a vehicle","description":"Retrieve a single, specific vehicle's details."}},"httpPath":"/vehicles/{vehicle_id}"},{"label":"Update a vehicle","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/patch-vehicles","routeSlug":"/ev.energy-api-v2/vehicles/patch-vehicles","metadata":{"seo":{"title":"Update a vehicle","description":"Update a vehicle."}},"httpPath":"/vehicles/{vehicle_id}"},{"label":"Remove a vehicle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/delete-vehicles","routeSlug":"/ev.energy-api-v2/vehicles/delete-vehicles","metadata":{"seo":{"title":"Remove a vehicle","description":"Remove a vehicle by disconnecting it from the ev.energy system."}},"httpPath":"/vehicles/{vehicle_id}"},{"label":"List vehicle trims","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_trims","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_trims","metadata":{"seo":{"title":"List vehicle trims","description":"List all the vehicle trims known by the ev.energy system."}},"httpPath":"/vehicle_trims"},{"label":"Create a custom vehicle trim","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicle_trims","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicle_trims","metadata":{"seo":{"title":"Create a custom vehicle trim","description":"Creates a new trim for the specified model that can be used if we are missing a trim. These trims will not be available in the list trims api call"}},"httpPath":"/vehicle_trims"},{"label":"Retrieve a vehicle trim","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_trims-vehicle_trim_id","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_trims-vehicle_trim_id","metadata":{"seo":{"title":"Retrieve a vehicle trim","description":"Retrieve details for a single, specific vehicle trim."}},"httpPath":"/vehicle_trims/{vehicle_trim_id}"},{"label":"List vehicle models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_models","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_models","metadata":{"seo":{"title":"List vehicle models","description":"List all the vehicle models known by the ev.energy system."}},"httpPath":"/vehicle_models"},{"label":"Create vehicle model","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicle_models","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicle_models","metadata":{"seo":{"title":"Create vehicle model","description":"Create a new vehicle model in the ev.energy system."}},"httpPath":"/vehicle_models"},{"label":"List a vehicle model's regional connectors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id-connectors","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id-connectors","metadata":{"seo":{"title":"List a vehicle model's regional connectors","description":"List a vehicle model's DC-fast connectors, one per charging region. A model's connector can differ by market (e.g. NACS in North America, CCS in Europe), so each row records the connector for one region. Public catalogue data."}},"httpPath":"/vehicle_models/{vehicle_model_id}/connectors"},{"label":"Add a regional connector to a vehicle model","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicle_models-vehicle_model_id-connectors","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicle_models-vehicle_model_id-connectors","metadata":{"seo":{"title":"Add a regional connector to a vehicle model","description":"Create a connector row for one region of a vehicle model.(vehicle_model, region) is unique; adding a second row for the sameregion returns a 400. Requires the vehicle_catalogue:write scope."}},"httpPath":"/vehicle_models/{vehicle_model_id}/connectors"},{"label":"Retrieve a vehicle model's connector for a region","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id-connectors-region","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id-connectors-region","metadata":{"seo":{"title":"Retrieve a vehicle model's connector for a region","description":"Retrieve a vehicle model's connector for a region"}},"httpPath":"/vehicle_models/{vehicle_model_id}/connectors/{region}"},{"label":"Update a vehicle model's connector for a region","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/patch-vehicle_models-vehicle_model_id-connectors-region","routeSlug":"/ev.energy-api-v2/vehicles/patch-vehicle_models-vehicle_model_id-connectors-region","metadata":{"seo":{"title":"Update a vehicle model's connector for a region","description":"Partially update the connector row for one region. Only the fieldssupplied are changed; region is the key and cannot be changed.Requires the vehicle_catalogue:write scope."}},"httpPath":"/vehicle_models/{vehicle_model_id}/connectors/{region}"},{"label":"Retrieve a vehicle model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id","metadata":{"seo":{"title":"Retrieve a vehicle model","description":"Retrieve details for a single, specific vehicle model."}},"httpPath":"/vehicle_models/{vehicle_model_id}"},{"label":"Get a vehicle model's regional default connector","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id-connector_default","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_models-vehicle_model_id-connector_default","metadata":{"seo":{"title":"Get a vehicle model's regional default connector","description":"The model's native DC-fast connector for the caller's charging region,for pre-filling the add-vehicle connector picker."}},"httpPath":"/vehicle_models/{vehicle_model_id}/connector_default"},{"label":"List vehicle makes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_makes","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_makes","metadata":{"seo":{"title":"List vehicle makes","description":"List all the vehicle makes known by the ev.energy system."}},"httpPath":"/vehicle_makes"},{"label":"Retrieve a vehicle make","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_makes-vehicle_make_id","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_makes-vehicle_make_id","metadata":{"seo":{"title":"Retrieve a vehicle make","description":"Retrieve details for a single, specific vehicle make."}},"httpPath":"/vehicle_makes/{vehicle_make_id}"},{"label":"List status logs for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-status_logs","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-status_logs","metadata":{"seo":{"title":"List status logs for a vehicle","description":"List the historical status logs for a specific Vehicle. Used to find out the state of the Vehicle at each point it reported in to ev.energy."}},"httpPath":"/vehicles/{vehicle_id}/status_logs"},{"label":"Retrieve a specific status log for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-status_logs-timestamp","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-status_logs-timestamp","metadata":{"seo":{"title":"Retrieve a specific status log for a vehicle","description":"A single status log for a particular vehicle is uniquely identified by the timestamp it was logged at."}},"httpPath":"/vehicles/{vehicle_id}/status_logs/{sampled_at}"},{"label":"List API error logs for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-error_logs","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-error_logs","metadata":{"seo":{"title":"List API error logs for a vehicle","description":"List the historical API error logs for a specific Vehicle. These logs capture errors that occurred when attempting to communicate with the vehicle's telematics API."}},"httpPath":"/vehicles/{vehicle_id}/error_logs"},{"label":"Retrieve a specific API error log for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-error_logs-timestamp","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-error_logs-timestamp","metadata":{"seo":{"title":"Retrieve a specific API error log for a vehicle","description":"A single API error log for a particular vehicle is uniquely identified by the timestamp it was logged at."}},"httpPath":"/vehicles/{vehicle_id}/error_logs/{logged_at}"},{"label":"List location logs for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-location_logs","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-location_logs","metadata":{"seo":{"title":"List location logs for a vehicle","description":"List the historical location log timestamps for a specific Vehicle. Returns metadata about when location data was recorded, without exposing the actual location coordinates."}},"httpPath":"/vehicles/{vehicle_id}/location_logs"},{"label":"Retrieve a specific location log for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-location_logs-timestamp","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-location_logs-timestamp","metadata":{"seo":{"title":"Retrieve a specific location log for a vehicle","description":"A single location log for a particular vehicle is uniquely identified by the timestamp it was sampled at. Returns metadata only, without exposing the actual location coordinates."}},"httpPath":"/vehicles/{vehicle_id}/location_logs/{sampled_at}"},{"label":"List command logs for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-command_logs","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-command_logs","metadata":{"seo":{"title":"List command logs for a vehicle","description":"List the historical command logs for a specific Vehicle. These logs record commands that were sent to the vehicle."}},"httpPath":"/vehicles/{vehicle_id}/command_logs"},{"label":"Retrieve a specific command log for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-command_logs-timestamp","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-command_logs-timestamp","metadata":{"seo":{"title":"Retrieve a specific command log for a vehicle","description":"A single command log for a particular vehicle is uniquely identified by the timestamp it was logged at."}},"httpPath":"/vehicles/{vehicle_id}/command_logs/{logged_at}"},{"label":"Get VPP modes for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-vpp_modes","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicles-vehicle_id-vpp_modes","metadata":{"seo":{"title":"Get VPP modes for a vehicle","description":"Returns the VPP (Virtual Power Plant) control modes supported by this vehicle."}},"httpPath":"/vehicles/{vehicle_id}/vpp_modes"},{"label":"Initiate vehicle onboarding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_onboarding","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_onboarding","metadata":{"seo":{"title":"Initiate vehicle onboarding","description":"Initiate the onboarding process for a new vehicle in your user's browser (or an embedded web view in an app)."}},"httpPath":"/vehicle_onboarding"},{"label":"Complete vehicle onboarding","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicle_onboarding-complete","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicle_onboarding-complete","metadata":{"seo":{"title":"Complete vehicle onboarding","description":"Exchanges a provider auth_code for a list of vehicles, completing an onboarding flow that was initiated via GET /v2/vehicle_onboarding/?response_type=json. Used primarily by native mobile clients integrating with the Smartcar Connect SDK (the SDK returns the auth_code directly to the app)."}},"httpPath":"/vehicle_onboarding/complete"},{"label":"Send vehicle onboarding link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicle_onboarding-onboarding_link","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicle_onboarding-onboarding_link","metadata":{"seo":{"title":"Send vehicle onboarding link","description":"Generates a vehicle onboarding deep link for the authenticated user and sends a Braze event containing the email, make name and onboarding URL."}},"httpPath":"/vehicle_onboarding/onboarding_link"},{"label":"Check vehicle model compatibility in a country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/get-vehicle_compatibility-check","routeSlug":"/ev.energy-api-v2/vehicles/get-vehicle_compatibility-check","metadata":{"seo":{"title":"Check vehicle model compatibility in a country","description":"Returns whether the given vehicle model is supported in the suppliedcountry. Used by the onboarding flow to tell the user upfrontwhether their vehicle will work before any account-linking step."}},"httpPath":"/vehicle_compatibility/check"},{"label":"Add user to the vehicle waitlist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicle_waitlist","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicle_waitlist","metadata":{"seo":{"title":"Add user to the vehicle waitlist","description":"Captures a user who hit an incompatible result on the vehicle compatibility check, so we can notify them once their hardware becomes supported. Pre-account, anonymous endpoint — no OAuth token required."}},"httpPath":"/vehicle_waitlist"},{"label":"Create reconnection URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicles-vehicle_id-reconnect","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicles-vehicle_id-reconnect","metadata":{"seo":{"title":"Create reconnection URL","description":"Create a reconnection request URL for the Vehicle."}},"httpPath":"/vehicles/{vehicle_id}/reconnect"},{"label":"Disconnect a vehicle's integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vehicles/post-vehicles-vehicle_id-disconnect","routeSlug":"/ev.energy-api-v2/vehicles/post-vehicles-vehicle_id-disconnect","metadata":{"seo":{"title":"Disconnect a vehicle's integration","description":"Disconnect the vehicle's integration. Revokes provider OAuth tokensand invalidates the underlying account, leaving the vehicle in anINACTIVE state. Any open charging sessions on cars sharing theaccount are closed. The vehicle's provider association is retainedso the user can re-link by POSTing to/vehicles/{vehicle_id}/reconnect."}},"httpPath":"/vehicles/{vehicle_id}/disconnect"},{"type":"link","label":"ProgramVehicleCompatibility","link":"/ev.energy-api-v2/vehicles/programvehiclecompatibility","routeSlug":"/ev.energy-api-v2/vehicles/programvehiclecompatibility","httpVerb":"schema"},{"type":"link","label":"Vehicle","link":"/ev.energy-api-v2/vehicles/vehicle","routeSlug":"/ev.energy-api-v2/vehicles/vehicle","httpVerb":"schema"},{"type":"link","label":"VehicleAPIErrorLog","link":"/ev.energy-api-v2/vehicles/vehicleapierrorlog","routeSlug":"/ev.energy-api-v2/vehicles/vehicleapierrorlog","httpVerb":"schema"},{"type":"link","label":"VehicleCommandLog","link":"/ev.energy-api-v2/vehicles/vehiclecommandlog","routeSlug":"/ev.energy-api-v2/vehicles/vehiclecommandlog","httpVerb":"schema"},{"type":"link","label":"VehicleConnectors","link":"/ev.energy-api-v2/vehicles/vehicleconnectors","routeSlug":"/ev.energy-api-v2/vehicles/vehicleconnectors","httpVerb":"schema"},{"type":"link","label":"VehicleLocationLog","link":"/ev.energy-api-v2/vehicles/vehiclelocationlog","routeSlug":"/ev.energy-api-v2/vehicles/vehiclelocationlog","httpVerb":"schema"},{"type":"link","label":"VehicleMake","link":"/ev.energy-api-v2/vehicles/vehiclemake","routeSlug":"/ev.energy-api-v2/vehicles/vehiclemake","httpVerb":"schema"},{"type":"link","label":"VehicleModel","link":"/ev.energy-api-v2/vehicles/vehiclemodel","routeSlug":"/ev.energy-api-v2/vehicles/vehiclemodel","httpVerb":"schema"},{"type":"link","label":"VehicleModelConnector","link":"/ev.energy-api-v2/vehicles/vehiclemodelconnector","routeSlug":"/ev.energy-api-v2/vehicles/vehiclemodelconnector","httpVerb":"schema"},{"type":"link","label":"VehicleModelConnectorDefault","link":"/ev.energy-api-v2/vehicles/vehiclemodelconnectordefault","routeSlug":"/ev.energy-api-v2/vehicles/vehiclemodelconnectordefault","httpVerb":"schema"},{"type":"link","label":"VehicleModelWrite","link":"/ev.energy-api-v2/vehicles/vehiclemodelwrite","routeSlug":"/ev.energy-api-v2/vehicles/vehiclemodelwrite","httpVerb":"schema"},{"type":"link","label":"VehicleOnboardingCompleteRequest","link":"/ev.energy-api-v2/vehicles/vehicleonboardingcompleterequest","routeSlug":"/ev.energy-api-v2/vehicles/vehicleonboardingcompleterequest","httpVerb":"schema"},{"type":"link","label":"VehicleOnboardingCompleteResponse","link":"/ev.energy-api-v2/vehicles/vehicleonboardingcompleteresponse","routeSlug":"/ev.energy-api-v2/vehicles/vehicleonboardingcompleteresponse","httpVerb":"schema"},{"type":"link","label":"VehicleOnboardingJsonResponse","link":"/ev.energy-api-v2/vehicles/vehicleonboardingjsonresponse","routeSlug":"/ev.energy-api-v2/vehicles/vehicleonboardingjsonresponse","httpVerb":"schema"},{"type":"link","label":"VehicleStateOfCharge","link":"/ev.energy-api-v2/vehicles/vehiclestateofcharge","routeSlug":"/ev.energy-api-v2/vehicles/vehiclestateofcharge","httpVerb":"schema"},{"type":"link","label":"VehicleStatusLog","link":"/ev.energy-api-v2/vehicles/vehiclestatuslog","routeSlug":"/ev.energy-api-v2/vehicles/vehiclestatuslog","httpVerb":"schema"},{"type":"link","label":"VehicleTrim","link":"/ev.energy-api-v2/vehicles/vehicletrim","routeSlug":"/ev.energy-api-v2/vehicles/vehicletrim","httpVerb":"schema"},{"type":"link","label":"VehicleTrimCreate","link":"/ev.energy-api-v2/vehicles/vehicletrimcreate","routeSlug":"/ev.energy-api-v2/vehicles/vehicletrimcreate","httpVerb":"schema"},{"type":"link","label":"VehicleWaitlistRequest","link":"/ev.energy-api-v2/vehicles/vehiclewaitlistrequest","routeSlug":"/ev.energy-api-v2/vehicles/vehiclewaitlistrequest","httpVerb":"schema"},{"type":"link","label":"VehicleWaitlistResponse","link":"/ev.energy-api-v2/vehicles/vehiclewaitlistresponse","routeSlug":"/ev.energy-api-v2/vehicles/vehiclewaitlistresponse","httpVerb":"schema"},{"type":"link","label":"Vehicle","link":"/ev.energy-api-v2/vehicles/vehiclewrite","routeSlug":"/ev.energy-api-v2/vehicles/vehiclewrite","httpVerb":"schema"}]},{"type":"group","label":"VPP","link":"/ev.energy-api-v2/vpp","routeSlug":"/ev.energy-api-v2/vpp","items":[{"label":"Get VPP modes for an EVSE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/get-evses-evse_id-vpp_modes","routeSlug":"/ev.energy-api-v2/vpp/get-evses-evse_id-vpp_modes","metadata":{"seo":{"title":"Get VPP modes for an EVSE","description":"Returns the VPP (Virtual Power Plant) control modes supported by this EVSE."}},"httpPath":"/evses/{evse_id}/vpp_modes"},{"label":"Get VPP modes for a vehicle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/get-vehicles-vehicle_id-vpp_modes","routeSlug":"/ev.energy-api-v2/vpp/get-vehicles-vehicle_id-vpp_modes","metadata":{"seo":{"title":"Get VPP modes for a vehicle","description":"Returns the VPP (Virtual Power Plant) control modes supported by this vehicle."}},"httpPath":"/vehicles/{vehicle_id}/vpp_modes"},{"label":"List dispatch coordinators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/get-dispatch_coordinators","routeSlug":"/ev.energy-api-v2/vpp/get-dispatch_coordinators","metadata":{"seo":{"title":"List dispatch coordinators","description":"List all available dispatch coordinators."}},"httpPath":"/dispatch_coordinators"},{"label":"Retrieve a dispatch coordinator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/get-dispatch_coordinators-dispatch_coordinator_id","routeSlug":"/ev.energy-api-v2/vpp/get-dispatch_coordinators-dispatch_coordinator_id","metadata":{"seo":{"title":"Retrieve a dispatch coordinator","description":"Retrieve a single dispatch coordinator's details."}},"httpPath":"/dispatch_coordinators/{dispatch_coordinator_id}"},{"label":"Create a dispatch event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/post-dispatch_coordinators-dispatch_coordinator_id-dispatch_events","routeSlug":"/ev.energy-api-v2/vpp/post-dispatch_coordinators-dispatch_coordinator_id-dispatch_events","metadata":{"seo":{"title":"Create a dispatch event","description":"Create a dispatch event for a dispatch coordinator. This is a placeholder endpoint — the event is validated and returned but not persisted."}},"httpPath":"/dispatch_coordinators/{dispatch_coordinator_id}/dispatch_events"},{"label":"Cancel a dispatch event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/post-dispatch_coordinators-dispatch_coordinator_id-dispatch_events-dispatch_event_id-cancel","routeSlug":"/ev.energy-api-v2/vpp/post-dispatch_coordinators-dispatch_coordinator_id-dispatch_events-dispatch_event_id-cancel","metadata":{"seo":{"title":"Cancel a dispatch event","description":"Cancel a dispatch event to stop an active or scheduled dispatch."}},"httpPath":"/dispatch_coordinators/{dispatch_coordinator_id}/dispatch_events/{dispatch_event_id}/cancel"},{"label":"List dispatch logs for a coordinator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/get-dispatch_coordinators-dispatch_coordinator_id-dispatch_logs","routeSlug":"/ev.energy-api-v2/vpp/get-dispatch_coordinators-dispatch_coordinator_id-dispatch_logs","metadata":{"seo":{"title":"List dispatch logs for a coordinator","description":"List the historical dispatch logs for a specific dispatch coordinator. These logs record aggregate fleet charging power at a point in time."}},"httpPath":"/dispatch_coordinators/{dispatch_coordinator_id}/dispatch_logs"},{"label":"Retrieve a specific dispatch log for a coordinator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/vpp/get-dispatch_coordinators-dispatch_coordinator_id-dispatch_logs-timestamp","routeSlug":"/ev.energy-api-v2/vpp/get-dispatch_coordinators-dispatch_coordinator_id-dispatch_logs-timestamp","metadata":{"seo":{"title":"Retrieve a specific dispatch log for a coordinator","description":"A single dispatch log for a particular dispatch coordinator is uniquely identified by the timestamp it was logged at."}},"httpPath":"/dispatch_coordinators/{dispatch_coordinator_id}/dispatch_logs/{logged_at}"},{"type":"link","label":"DispatchCoordinator","link":"/ev.energy-api-v2/vpp/dispatchcoordinator","routeSlug":"/ev.energy-api-v2/vpp/dispatchcoordinator","httpVerb":"schema"},{"type":"link","label":"DispatchEvent","link":"/ev.energy-api-v2/vpp/dispatchevent","routeSlug":"/ev.energy-api-v2/vpp/dispatchevent","httpVerb":"schema"},{"type":"link","label":"DispatchEventCancelResponse","link":"/ev.energy-api-v2/vpp/dispatcheventcancelresponse","routeSlug":"/ev.energy-api-v2/vpp/dispatcheventcancelresponse","httpVerb":"schema"},{"type":"link","label":"DispatchEventWrite","link":"/ev.energy-api-v2/vpp/dispatcheventwrite","routeSlug":"/ev.energy-api-v2/vpp/dispatcheventwrite","httpVerb":"schema"},{"type":"link","label":"DispatchLog","link":"/ev.energy-api-v2/vpp/dispatchlog","routeSlug":"/ev.energy-api-v2/vpp/dispatchlog","httpVerb":"schema"}]},{"type":"group","label":"Webhooks","link":"/ev.energy-api-v2/webhooks","routeSlug":"/ev.energy-api-v2/webhooks","items":[{"label":"Retrieve access link for webhook portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/webhooks/get-webhook_portal","routeSlug":"/ev.energy-api-v2/webhooks/get-webhook_portal","metadata":{"seo":{"title":"Retrieve access link for webhook portal","description":"Generate a one time use link to access the portal to configure webhooks."}},"httpPath":"/webhook_portal"}]},{"type":"group","label":"Auth","link":"/ev.energy-api-v2/auth","routeSlug":"/ev.energy-api-v2/auth","items":[{"label":"Request a password reset email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/auth/post-auth-password_reset","routeSlug":"/ev.energy-api-v2/auth/post-auth-password_reset","metadata":{"seo":{"title":"Request a password reset email","description":"Request a password reset email for the account with the supplied email address. The response status and body are identical whether or not an account exists for the email; clients must not treat the success response as confirmation that an account exists."}},"httpPath":"/auth/password_reset"}]},{"type":"group","label":"CT Clamps","link":"/ev.energy-api-v2/ct-clamps","routeSlug":"/ev.energy-api-v2/ct-clamps","items":[{"label":"List CT Clamps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/ct-clamps/get-ct-clamps","routeSlug":"/ev.energy-api-v2/ct-clamps/get-ct-clamps","metadata":{"seo":{"title":"List CT Clamps","description":"List all CT clamps that the authorization token has access to."}},"httpPath":"/ct_clamps"},{"label":"Retrieve a CT Clamp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/ct-clamps/get-ct-clamps-ct_clamp_id","routeSlug":"/ev.energy-api-v2/ct-clamps/get-ct-clamps-ct_clamp_id","metadata":{"seo":{"title":"Retrieve a CT Clamp","description":"Retrieve a single CT clamp's details."}},"httpPath":"/ct_clamps/{ct_clamp_id}"},{"label":"List logs for a CT Clamp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/ct-clamps/get-ct-clamps-ct_clamp_id-logs","routeSlug":"/ev.energy-api-v2/ct-clamps/get-ct-clamps-ct_clamp_id-logs","metadata":{"seo":{"title":"List logs for a CT Clamp","description":"List the historical current measurement logs for a specific CT clamp."}},"httpPath":"/ct_clamps/{ct_clamp_id}/logs"},{"label":"Retrieve a log for a CT Clamp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/ct-clamps/get-ct-clamps-ct_clamp_id-logs-sampled_at","routeSlug":"/ev.energy-api-v2/ct-clamps/get-ct-clamps-ct_clamp_id-logs-sampled_at","metadata":{"seo":{"title":"Retrieve a log for a CT Clamp","description":"Retrieve a single CT clamp log entry."}},"httpPath":"/ct_clamps/{ct_clamp_id}/logs/{sampled_at}"},{"type":"link","label":"CTClamp","link":"/ev.energy-api-v2/ct-clamps/ctclamp","routeSlug":"/ev.energy-api-v2/ct-clamps/ctclamp","httpVerb":"schema"},{"type":"link","label":"CTClampLog","link":"/ev.energy-api-v2/ct-clamps/ctclamplog","routeSlug":"/ev.energy-api-v2/ct-clamps/ctclamplog","httpVerb":"schema"}]},{"type":"group","label":"Grid","link":"/ev.energy-api-v2/grid","routeSlug":"/ev.energy-api-v2/grid","items":[{"label":"List grid feeds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/grid/get-grid_feeds","routeSlug":"/ev.energy-api-v2/grid/get-grid_feeds","metadata":{"seo":{"title":"List grid feeds","description":"List all grid feeds visible to the authenticated client. Grid feeds represent sources of grid signal data used for smart charging decisions."}},"httpPath":"/grid_feeds"},{"label":"Retrieve a grid feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/grid/get-grid_feeds-grid_feed_id","routeSlug":"/ev.energy-api-v2/grid/get-grid_feeds-grid_feed_id","metadata":{"seo":{"title":"Retrieve a grid feed","description":"Retrieve a specific grid feed used for smart charging decisions."}},"httpPath":"/grid_feeds/{grid_feed_id}"},{"label":"List levels for a grid feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/grid/get-grid_feeds-grid_feed_id-levels","routeSlug":"/ev.energy-api-v2/grid/get-grid_feeds-grid_feed_id-levels","metadata":{"seo":{"title":"List levels for a grid feed","description":"Returns all levels for the specified grid feed. Levels represent the time-varying signal values that influence smart charging decisions. Each level applies to a specific time interval and has a value between 1 and 100, where values above 50 discourage charging and values below 50 encourage it."}},"httpPath":"/grid_feeds/{grid_feed_id}/levels"},{"type":"link","label":"GridFeed","link":"/ev.energy-api-v2/grid/gridfeed","routeSlug":"/ev.energy-api-v2/grid/gridfeed","httpVerb":"schema"},{"type":"link","label":"GridLevel","link":"/ev.energy-api-v2/grid/gridlevel","routeSlug":"/ev.energy-api-v2/grid/gridlevel","httpVerb":"schema"}]},{"type":"group","label":"HEM Systems","link":"/ev.energy-api-v2/hem-systems","routeSlug":"/ev.energy-api-v2/hem-systems","items":[{"label":"List HEM systems","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/hem-systems/get-hem_systems","routeSlug":"/ev.energy-api-v2/hem-systems/get-hem_systems","metadata":{"seo":{"title":"List HEM systems","description":"List all the HEM systems that the authorization token has access to."}},"httpPath":"/hem_systems"},{"label":"Retrieve a HEM system","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/hem-systems/get-hem_systems-hem_system_id","routeSlug":"/ev.energy-api-v2/hem-systems/get-hem_systems-hem_system_id","metadata":{"seo":{"title":"Retrieve a HEM system","description":"Retrieve a single HEM (Home Energy Management) system by ID."}},"httpPath":"/hem_systems/{hem_system_id}"},{"label":"Get aggregated energy statistics for a HEM system","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/hem-systems/get-hem_systems-hem_system_id-energy_stats","routeSlug":"/ev.energy-api-v2/hem-systems/get-hem_systems-hem_system_id-energy_stats","metadata":{"seo":{"title":"Get aggregated energy statistics for a HEM system","description":"Returns aggregated energy statistics for the HEM system over a specified time range and resolution."}},"httpPath":"/hem_systems/{hem_system_id}/energy_stats"},{"label":"Get live power data for a HEM system","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/hem-systems/get-hem_systems-hem_system_id-live_power","routeSlug":"/ev.energy-api-v2/hem-systems/get-hem_systems-hem_system_id-live_power","metadata":{"seo":{"title":"Get live power data for a HEM system","description":"Returns live power data for the HEM system. Power values (in watts) are derived from the most recent energy statistics, including raw measurements and calculated power flows between sources (solar, battery, grid) and destinations (home, battery, grid)."}},"httpPath":"/hem_systems/{hem_system_id}/live_power"},{"type":"link","label":"HEMSystem","link":"/ev.energy-api-v2/hem-systems/hemsystem","routeSlug":"/ev.energy-api-v2/hem-systems/hemsystem","httpVerb":"schema"},{"type":"link","label":"HEMSystemEnergyStatsBucket","link":"/ev.energy-api-v2/hem-systems/hemsystemenergystatsbucket","routeSlug":"/ev.energy-api-v2/hem-systems/hemsystemenergystatsbucket","httpVerb":"schema"},{"type":"link","label":"HEMSystemEnergyStatsResponse","link":"/ev.energy-api-v2/hem-systems/hemsystemenergystatsresponse","routeSlug":"/ev.energy-api-v2/hem-systems/hemsystemenergystatsresponse","httpVerb":"schema"},{"type":"link","label":"HEMSystemLivePower","link":"/ev.energy-api-v2/hem-systems/hemsystemlivepower","routeSlug":"/ev.energy-api-v2/hem-systems/hemsystemlivepower","httpVerb":"schema"}]},{"type":"group","label":"Boundary Meters","link":"/ev.energy-api-v2/boundary-meters","routeSlug":"/ev.energy-api-v2/boundary-meters","items":[{"label":"List boundary meter makes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_makes","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_makes","metadata":{"seo":{"title":"List boundary meter makes","description":"List all the boundary meter makes known by the ev.energy system."}},"httpPath":"/boundary_meter_makes"},{"label":"Retrieve a boundary meter make","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_makes-boundary_meter_make_id","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_makes-boundary_meter_make_id","metadata":{"seo":{"title":"Retrieve a boundary meter make","description":"Retrieve details for a single, specific boundary meter make."}},"httpPath":"/boundary_meter_makes/{boundary_meter_make_id}"},{"label":"List boundary meter models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_models","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_models","metadata":{"seo":{"title":"List boundary meter models","description":"List all the boundary meter models known by the ev.energy system."}},"httpPath":"/boundary_meter_models"},{"label":"Retrieve a boundary meter model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_models-boundary_meter_model_id","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meter_models-boundary_meter_model_id","metadata":{"seo":{"title":"Retrieve a boundary meter model","description":"Retrieve details for a single, specific boundary meter model."}},"httpPath":"/boundary_meter_models/{boundary_meter_model_id}"},{"label":"List boundary meters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meters","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meters","metadata":{"seo":{"title":"List boundary meters","description":"List all the boundary meters that the authorization token has access to."}},"httpPath":"/boundary_meters"},{"label":"Retrieve a boundary meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meters-boundary_meter_id","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meters-boundary_meter_id","metadata":{"seo":{"title":"Retrieve a boundary meter","description":"Retrieve a single, specific boundary meter's details."}},"httpPath":"/boundary_meters/{boundary_meter_id}"},{"label":"List status logs for a boundary meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meters-boundary_meter_id-status_logs","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meters-boundary_meter_id-status_logs","metadata":{"seo":{"title":"List status logs for a boundary meter","description":"List the historical status logs for a specific boundary meter. Used to find out the state of the meter at each point it reported in to ev.energy."}},"httpPath":"/boundary_meters/{boundary_meter_id}/status_logs"},{"label":"Retrieve a status log for a boundary meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/boundary-meters/get-boundary_meters-boundary_meter_id-status_logs-timestamp","routeSlug":"/ev.energy-api-v2/boundary-meters/get-boundary_meters-boundary_meter_id-status_logs-timestamp","metadata":{"seo":{"title":"Retrieve a status log for a boundary meter","description":"A boundary meter status log is uniquely identified by the combination of boundary meter ID and the time it was sampled at."}},"httpPath":"/boundary_meters/{boundary_meter_id}/status_logs/{sampled_at}"},{"type":"link","label":"BoundaryMeter","link":"/ev.energy-api-v2/boundary-meters/boundarymeter","routeSlug":"/ev.energy-api-v2/boundary-meters/boundarymeter","httpVerb":"schema"},{"type":"link","label":"BoundaryMeterMake","link":"/ev.energy-api-v2/boundary-meters/boundarymetermake","routeSlug":"/ev.energy-api-v2/boundary-meters/boundarymetermake","httpVerb":"schema"},{"type":"link","label":"BoundaryMeterModel","link":"/ev.energy-api-v2/boundary-meters/boundarymetermodel","routeSlug":"/ev.energy-api-v2/boundary-meters/boundarymetermodel","httpVerb":"schema"},{"type":"link","label":"BoundaryMeterStatusLog","link":"/ev.energy-api-v2/boundary-meters/boundarymeterstatuslog","routeSlug":"/ev.energy-api-v2/boundary-meters/boundarymeterstatuslog","httpVerb":"schema"}]},{"type":"group","label":"Reference Data","link":"/ev.energy-api-v2/reference-data","routeSlug":"/ev.energy-api-v2/reference-data","items":[{"label":"List Timezones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/reference-data/get-timezones","routeSlug":"/ev.energy-api-v2/reference-data/get-timezones","metadata":{"seo":{"title":"List Timezones","description":"Get the list of available IANA timezones."}},"httpPath":"/timezones"},{"label":"Retrieve a timezone","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ev.energy-api-v2/reference-data/get-timezones-timezone_id","routeSlug":"/ev.energy-api-v2/reference-data/get-timezones-timezone_id","metadata":{"seo":{"title":"Retrieve a timezone","description":"Retrieve a single timezone by its ID."}},"httpPath":"/timezones/{timezone_id}"}]}]}