v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Vehicles

Retrieve a list of vehicles

Required scope: vehicles:read

get/api/v1/vehicles

Query parameters

pageinteger

Page number to retrieve (starts with 0)

perPageinteger

Number of items per page (between 1 and 100, default 10)

ownerIdinteger

Filter to retrieve vehicles with specified team ID or user ID defined by ownerType

Example:13

ownerType'team' | 'user' required

Filter by owner type of the vehicle

Example:team

Response

List of vehicles that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "teamId": 2,
      "userId": 3,
      "name": "Tesla",
      "licensePlate": "CT88585",
      "batteryCapacityKwh": 85,
      "maxPowerKwAc": 29,
      "maxPowerKwDc": 35.5,
      "displayName": "Tesla Model 3 Performance (2021) - 72 kWh",
      "integrationId": 89188,
      "integrationStatus": "connected",
      "customSpecification": {
        "brand": "Volvo",
        "model": "FH Electric",
        "vehicleType": "truck"
      },
      "vid": "VID:001681036794"
    }
  ]
}