Skip to main content
GET
/
vehicles
/
{vehicle}
Retrieve a vehicle
curl --request GET \
  --url https://api.chargeapi.co/v1/vehicles/{vehicle} \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": null,
  "object": null,
  "battery_capacity": null,
  "charging_standard": null,
  "created": null,
  "drivers": null,
  "fleet": null,
  "information": {
    "make": null,
    "model": null,
    "year": null
  },
  "metadata": null,
  "registration_plate": null,
  "status": null,
  "telemetry": null,
  "updated": null,
  "vin": null
}

Path Parameters

​
vehicle
string
required

ID of the vehicle to retrieve.

Query Parameters

​
expand
string[]

Specifies related objects to expand (e.g., expand[]=drivers).

Body

application/json · object

Response

Returns the Vehicle object for a valid identifier. Raises an error otherwise.

​
id
string

Unique identifier for the vehicle object.

Example:

null

​
object
string

String representing the object’s type. Always vehicle.

Example:

null

​
battery_capacity
integer

Total battery capacity of the vehicle in watt-hours (Wh).

Example:

null

​
charging_standard
string

Standard used for charging the vehicle (e.g., CCS, CHAdeMO, Type2).

Example:

null

​
created
integer

Time at which the vehicle was registered (UNIX timestamp).

Example:

null

​
drivers
string[]

List of driver IDs currently linked to the vehicle.

Example:

null

​
fleet
string | null

ID of the fleet this Vehicle is attached to, if any.

Example:

null

​
information
object

Manufacturer details for the vehicle.

​
metadata
object

Set of key-value pairs for storing custom structured data about the vehicle.

Example:

null

​
registration_plate
string

License plate or vehicle registration number.

Example:

null

​
status
enum<string>

Current lifecycle status of the vehicle.

Available options:
active,
inactive,
retired
Example:

null

​
telemetry
string

ID of the telemetry object linked to this vehicle (if any).

Example:

null

​
updated
integer

Time at which the vehicle object was last updated.

Example:

null

​
vin
string

Vehicle Identification Number (VIN), used to uniquely identify the vehicle.

Example:

null