How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ev.energy Users API

Endpoints for interacting with users.

ev.energy Users API is one of 25 APIs that ev.energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 16 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 2 base URLs: https://api.ev.energy/v2, https://api-staging.ev.energy/v2.

16 operations 7 paths 23 schemas 2 DELETE7 GET5 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.ev.energy/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ev.energy Users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials and authorizationCode flows, exposing 35 scopes. By default, every request must be authenticated.

Paths & Operations 16

Across 7 paths, the API surfaces 16 operations — 2 DELETE, 7 GET, 5 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Users 16

Endpoints for interacting with users.

GET
/users
List users
get-users 7 params → 200400401403406429
POST
/users
Create user
post-users 1 param body → 201400401403404406429
GET
/users/{user_id}
Retrieve user
get-users-user_id 3 params → 200400401403404406429
PATCH
/users/{user_id}
Update User
patch-users-user_id 3 params body → 200400401403404406429
GET
/users/{user_id}/notification_preferences
Retrieve user notification preferences
get-users-user_id-notification_preferences 2 params → 200400401403404405406429
PATCH
/users/{user_id}/notification_preferences
Update user notification preferences
patch-users-user_id-notification_preferences 2 params body → 200400401403404405406429
GET
/users/{user_id}/route_planner_preferences
Retrieve route planner preferences
get-users-user_id-route_planner_preferences 2 params → 200400401403404405406429
PATCH
/users/{user_id}/route_planner_preferences
Update route planner preferences
patch-users-user_id-route_planner_preferences 2 params body → 200400401403404405406429
GET
/users/{user_id}/payout_method
Retrieve payout method
get-users-user_id-payout-method 2 params → 200400401403404405406429
PATCH
/users/{user_id}/payout_method
Update payout method
patch-users-user_id-payout-method 2 params body → 200400401403404405406429
DELETE
/users/{user_id}/payout_method
Delete payout method
delete-users-user_id-payout-method 2 params → 204400401403404405406429
GET
/users/{user_id}/saved_routes
List saved routes
get-users-user_id-saved_routes 5 params → 200400401403404405406429
POST
/users/{user_id}/saved_routes
Create a saved route
post-users-user_id-saved_routes 2 params body → 201400401403404405406429
GET
/users/{user_id}/saved_routes/{saved_route_id}
Retrieve a saved route
get-users-user_id-saved_routes-saved_route_id 3 params → 200400401403404405406429
PATCH
/users/{user_id}/saved_routes/{saved_route_id}
Update a saved route
patch-users-user_id-saved_routes-saved_route_id 3 params body → 200400401403404405406429
DELETE
/users/{user_id}/saved_routes/{saved_route_id}
Delete a saved route
delete-users-user_id-saved_routes-saved_route_id 3 params → 204400401403404405406429

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are TariffBase (13 properties), Notification (13 properties), SavedRoute (12 properties), Location (9 properties). Each schema is shown below with its type and property counts.

RFC9457ProblemDetail
object
6 properties 2 required
Supplier
object
An energy company who supplies electricity tariffs.
5 properties 4 required
DailyPrices
object
Information about the tariff's prices for different parts of the day.
3 properties 1 required
Notification
object
Something that the user should be informed about.
13 properties 11 required
Tariff
Note: dailyprices and type are only available under contract. Please reach out to your account manager to find out more.
EVSESite
object
Represents a place with one or more EVSEs installed which can be accessed by multiple users.
6 properties 4 required
RoutePlannerPreferencesUpdate
object
Request body for PATCH /users/{userid}/routeplannerpreferences. All fields are optional; only those supplied are changed.
3 properties
SavedRoute
object
A user's saved route-planner route — a reusable origin/destination/ waypoints "recipe" plus planning preferences. It deliberately does not store the resulting…
12 properties 12 required
PayoutMethodUpdate
object
Request body for PATCH /users/{userid}/payoutmethod. receiverwallet is always required. For PAYPAL and VENMO the client must also supply receiver (an email or…
2 properties 1 required
CountryCode
string
ISO 3166-1 2 letter Country Codes.
LocationDetail
Extra fields only included when a single location is requested but omitted when locations are listed.
UserNotificationPreferences
object
The user's notification group opt-in state. On GET, every known group is returned with its current boolean state. On PATCH, only the keys you include are modif…
2 properties
PriceSummary
object
A single price for a certain time range.
2 properties
RoutePlannerPreferences
object
A user's sticky EV Route Planner preferences, created with defaults on first access. PATCH treats the body as a partial map — only the keys you include are cha…
5 properties 5 required
SavedRouteCreate
object
Request body for POST /users/{userid}/savedroutes.
8 properties 4 required
Location
object
Location model for charging locations. Address validation: Address fields are optional as a group, but each field independently triggers the requirement. If an…
9 properties
SavedRoutePatch
object
Request body for PATCH /users/{userid}/savedroutes/{savedrouteid}. All fields are optional; only those supplied are changed.
8 properties
TariffBase
object
Core tariff properties shared by Tariff and expanded schedulertariff. Note: dailyprices and type are only available under contract. Please reach out to your ac…
13 properties 5 required
Times
object
Defines a period of time.
2 properties
User
object
A resource that represents an individual user in the ev.energy system.
9 properties 2 required
PayoutMethod
object
The user's preferred payout method. All three fields are nullable when no payout method has been set up. receivertype and the format of receiver are determined…
4 properties 4 required
LatLong
object
Coordinates model used for locations.
2 properties 2 required
RoutePoint
object
A single geographic point on a saved route.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ev-energy-users-api-openapi.yml Raw ↑

Other APIs ev.energy publishes across the network.

ev.energy Auth API
ev.energy Boundary Meters API
ev.energy Carbon API
ev.energy Charging Sessions API
ev.energy CT Clamps API
ev.energy EVS Es API
ev.energy Grid API
ev.energy HEM Systems API
ev.energy Home Batteries API
ev.energy Notifications API
ev.energy Programs API
ev.energy Rebates API
Where this information came from

This is an independent, third-party profile of ev.energy Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.