Get Vehicles

/v2/vehicles

Returns the list of vehicles in the account.

Parameters

Kind

Allows to specify a kind of vehicle to search for.

Possible values for kind are: V: Vehicle ; A: Asset.

No char V

typeId

Allows to specify a type of vehicle to search for.
Types of vehicles are managed in the account administration.
The list of vehicle types can be obtained using the endpoint Get vehicle types.
You can also find information about vehicle how to manage vehicle types in the following link: https://frotcominternational.zendesk.com/hc/en-gb/articles/211242089

No char

includeSensors

Specifies if the information about the vehicles sensors should be included in the response.

No boolean false

includeSensors

Specifies if the information about the vehicles failure counts should be included in the response.

No boolean false

Return

When vehicles are found, an array of objects width data about eac vehicle is returned.

[{
  "id": 123,
  "hasCanbus": true,
  "hasObd2": false,
  "licensePlate": "ABC-1234",
  "classId": 2,
  "kind": "V",
  "vehicleId": 456,
  "coupledLicensePlate": "DEF-5678",
  "isOnTrip": true,
  "driverId": 789,
  "driverRef": "jdoe",
  "driverName": "John Doe",
  "driverMSISDN": "+1234567890",
  "coDriverId": 1011,
  "coDriverRef": "asmith",
  "coDriverName": "Alice Smith",
  "coDriverMSISDN": "+1987654321",
  "latitude": 40.7128,
  "longitude": -74.0060,
  "stopDuration": 3600.5,
  "speed": 65.5,
  "direction": 180.0,
  "isOnPrivacy": false,
  "odometerGps": 12345.6,
  "odometerCanBus": 12350.7,
  "tracking": 3,
  "imei": "359876543210123",
  "departmentId": 20,
  "departementName": "Logistics",
  "segmentId": 30,
  "segmentName": "Freight",
  "deviceType": "X1000",
  "typeId": 5,
  "lastCommunication": "2025-07-17T12:00:00Z",
  "immobillizer": 2,
  "communicationStatus": 1,
  "hasImmobillizer": true,
  "hasBuzzer": false,
  "manufacturer": "Ford",
  "model": "Transit",
  "modelYear": 2020,
  "stopSpeedLimit": 5,
  "isStopped": false,
  "odometerOk": true,
  "totalFuelOk": true,
  "engineHoursOk": true,
  "chronometer": 7200.0,
  "field1": "Primary vehicle",
  "field2": "Warehouse route",
  "field3": "",
  "field4": "",
  "field5": "",
  "icon": 7,
  "assetId": 321,
  "driverDrivingTimes": {
    "driverId": 789,
    "continuous": 75.0,
    "continuousSec": 27000,
    "dailySec": 36000,
    "daily": 80,
    "weeklySec": 180000,
    "weekly": 90,
    "biweeklySec": 360000,
    "biweekly": 95,
    "isMultiManning": false
  },
  "alarms": {
    "total": 5,
    "name": "engine_overheat"
  },
  "trips": {
    "mileageGps": 120.5,
    "mileageCanbus": 118.3,
    "total": 3
  },
  "messages": {
    "total": 2,
    "name": "Maintenance due"
  },
  "canSendMessage": true,
  "placeName": "Main Warehouse",
  "lastGps": "2025-07-17T11:59:00Z",
  "noGps": 0.1,
  "failures": {
    "powerFailureCount": 1,
    "ignitionFailureCount": 0
  }
}]

FieldDescription
id Vehicle Id int
hasCanbus true if vehicle has Canbus bool
hasObd2 true if vehicle has Obd2, otherwise false bool
licensePlate Vehicle license plate string
classId The ID of the class of the vehicle.
The list of vehicle classes can be found here. int
kind A character that represents the kind of the vehicle:
FieldDescription
A Asset
V Vehicle
char
vehicleId Vehicle coupled id int
coupledLicensePlate Vehicle coupled license plate string
isOnTrip true if ignition is on, false if off, null if no comms >2 h bool
driverId Id of Driver; if isNow is true, last driver in interval. int
driverRef Driver username for WFM login string
driverName Name of Driver; if isNow true, last driver in interval string
driverMSISDN Phone number of Driver; if isNow true, last in interval string
coDriverId Id of Codriver; if isNow true, last codriver in interval int
coDriverRef Codriver username for WFM login string
coDriverName Name of Codriver; if isNow true, last codriver in interval string
coDriverMSISDN Phone number of Codriver; if isNow true, last in interval string
latitude Last registered Latitude; if isNow true, last in interval double
longitude Last registered Longitude; if isNow true, last in interval double
stopDuration Vehicle stopped time in seconds double
speed Last registered speed; if isNow true, last in interval double
direction Last registered direction double
isOnPrivacy true if vehicle is on privacy mode bool
odometerGps Mileage tracked by GPS double
odometerCanBus Mileage tracked by CanBus double
tracking The kind of tracking that is applied to the vehicle.
Find the list of kinds of traking HERE enum
imei Imei of the device. string
departmentId Department Id of the vehicle. int
departementName Department name of the vehicle. string
segmentId Segment Id of the vehicle. int
segmentName Segment name of the vehicle. string
deviceType Device model. string
typeId Vehicle type id. int
lastCommunication Last communication datetime; if isNow true, last in interval datetime
immobillizer The state of the immobilizer
FieldDescription
0Inactive
1Pending
2Active
3Inactive
4Deactivated
int
communicationStatus The status of the communication between the device and Frotcom.
FieldDescription
1Communicating
225 h problem: The vehicle is not communicating for 25 hours or more.
32 h problem: The vehicle is not communicating for 25 hours or more.
short
hasImmobillizer true if vehicle has immobillizer bool
hasBuzzer true if vehicle has Buzzer bool
manufacturer Vehicle manufacturer string
model Vehicle model string
modelYear Year of production int
stopSpeedLimit Minimum speed to consider that the vehicle is moving. int
isStopped true if speed < StopSpeedLimit bool
odometerOk true if Canbus odometer is valid bool
totalFuelOk true if Canbus total fuel is valid bool
engineHoursOk true if Canbus engine hours is valid bool
chronometer Vehicle chronometer double
field1 Any vehicle info string
field2 Any vehicle info string
field3 Any vehicle info string
field4 Any vehicle info string
field5 Any vehicle info string
icon Identifies vehicle icon in interface int
assetId Id of asset; if isNow true, last in interval int
driverDrivingTimes Object containing:
FieldDescription
driverIdint Driver Id
continuousdouble % continuous driving time
continuousSeclong Continuous driving seconds
dailySeclong Daily driving seconds
dailylong % daily driving time
weeklySeclong Weekly driving seconds
weeklylong % weekly driving time
biweeklySeclong Biweekly driving seconds
biweeklylong % biweekly driving time
isMultiManningbool true if multi‐manning
alarms Object containing:
totalint Total alarms in interval
namestring Translation key of last alarm
trips Object containing:
FieldDescription
mileageGpsdouble GPS mileage in interval
mileageCanbusdouble CanBus mileage in interval
totalint Total trips in interval
messages Object containing:
FieldDescription
totalint Messages sent in interval
namestring Last text message
canSendMessage true if any terminal available bool
placeName Last stop place name string
lastGps Date and time of last valid GPS DateTime
noGps % invalid GPS records (ignition on) in last 7 days double
failures Object containing:
FieldDescription
powerFailureCount Power failures in last 7 days int
ignitionFailureCount Ignition failures in last 7 days int

Response HTTP Codes

200 - OK

  • A list of vehicles is returned

204 - No content

  • No vehicles were found

401 - Unauthorized

  • Invalid credentials