Skip to content
/
List vehicle trims

List vehicle trims

Request

List all the vehicle trims known by the ev.energy system.

Trim refers to a set of features that can be applied to a particular model of vehicle: https://en.wikipedia.org/wiki/Car_model#Trim_level.

Pass ?ordering=name (or -name) to sort results alphabetically by name. Without an ordering parameter, results are returned in their default creation order.

Security
oauth2(Required scopes: vehicle:read)
Query
page_beforestring[a-z]{4}[A-Z\d]{26}

Return results from the page after this ID.

Example:page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_afterstring[a-z]{4}[A-Z\d]{26}

Return results from the page before this ID.

Example:page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_sizeinteger, [ 1 .. 100 ]

Specify the number of results to return per page.

Default:25
Example:page_size=10
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum:"model""model.make"
model_idstring

The ID of a Vehicle Model to filter by.

Example:model_id=vmod01HN2NV5DY9C262PQKG75GHN8K
orderingstring

Sort the list alphabetically by name (-name for reverse). When omitted, results are returned in their default creation order. Unrecognised values silently fall back to the default ordering.

Enum:"name""-name"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/vehicle_trims?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10&expand=model&model_id=vmod01HN2NV5DY9C262PQKG75GHN8K&ordering=name' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

Return a list of vehicle trims.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
Array [
idstringtrim[A-Z\d]{26}read-onlyrequired

Unique identifier for the given Vehicle Trim.

Example:"trim01HRFHBCM7VBSWRPVYFBQMH2BR"
urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/v2/vehicle_trim/trim01HRFHBCM7VBSWRPVYFBQMH2BR"
namestringread-onlyrequired
Example:"Recharge Core (69 kWh)"
modelstring or VehicleModel (object)
One of:
string (uri)
battery_size_watt_hoursinteger or nullread-only

Battery size in watt-hours. null if not known for this trim.

Example:75500
onboarding_urlstring or null, (uri)read-onlyrequired

A pre-constructed link to initiate onboarding for a vehicle with this trim. If it is null, then we do not support intergrating with this vehicle and you should POST the trim to /vehicles to create an unintegrated vehicle.

Your client_id and the user's user_id are automatically included based on your authentication token. If you are using client credentials authentication, the user ID will not be automatically included unless you set the EvEnergy-User header on your request.

Example:"https://api.ev.energy/v2/vehicle_onboarding?trim_id=trim01HN2NZ1040Y8E77CQGXADC2TZ&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735&client_id=your_client_id"
]
Response
[
  {
    "id": "trim01HRFHBCM7VBSWRPVYFBQMH2BR",
    "url": "https://api.ev.energy/v2/vehicle_trim/trim01HRFHBCM7VBSWRPVYFBQMH2BR",
    "name": "Recharge Core (69 kWh)",
    "model": "http://example.com",
    "battery_size_watt_hours": 75500,
    "onboarding_url": "https://api.ev.energy/v2/vehicle_onboarding?trim_id=trim01HN2NZ1040Y8E77CQGXADC2TZ&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735&client_id=your_client_id"
  }
]