Samsara Vehicles API
The Vehicles API from Samsara — 14 operation(s) for vehicles.
Samsara Vehicles API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Vehicles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 15 operations across 14 paths, and defines 286 schemas. It is described by OpenAPI 3.0.1, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
15 operations
14 paths
286 schemas
14 GET1 PATCH
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Vehicles API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 15
Across 14 paths, the API surfaces 15 operations — 14 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.
Vehicles 15
GET
/fleet/vehicles
List All Vehicles.
GET
/fleet/vehicles/driver-assignments
[legacy] Get All Drivers Assigned to a Set of Vehicles
GET
/fleet/vehicles/immobilizer/stream
[beta] Get Engine Immobilizer States
GET
/fleet/vehicles/locations
Locations Snapshot
GET
/fleet/vehicles/locations/feed
Locations Feed
GET
/fleet/vehicles/locations/history
Historical Locations
GET
/fleet/vehicles/stats
Stats Snapshot
GET
/fleet/vehicles/stats/feed
Stats Feed
GET
/fleet/vehicles/stats/history
Historical Stats
GET
/fleet/vehicles/tachograph-files/history
Get Tachograph Vehicle Files
GET
/fleet/vehicles/{id}
Retrieve a Vehicle
PATCH
/fleet/vehicles/{id}
Update a Vehicle
GET
/preview/driver-efficiency/vehicles
[preview] Get Driver Efficiency Data Grouped by Vehicles.
GET
/v1/fleet/vehicles/{vehicleId}/safety/harsh_event
Fetch Harsh Events
GET
/v1/fleet/vehicles/{vehicleId}/safety/score
Fetch Vehicle Safety Scores
Schemas 286
The contract defines 286 schemas that model the data the API accepts and returns. The most detailed are VehicleStatsResponse_data (62 properties), VehicleStatsListResponse_data (62 properties), VehicleStatsDecorations (58 properties), VehicleResponseObjectResponseBody (38 properties). Each schema is shown below with its type and property counts.
VehicleStatsEngineLoadPercentWithDecoration
object
The engine load percentage reading.
3 properties
2 required
VehicleStatsResponse_spreaderPlowStatus
object
Snow plow status (Up or Down), as read from the material spreader. Note: this is separate from plow status defined via auxInput.
2 properties
2 required
VehicleStatsResponse_spreaderBlastState
object
Whether vehicle is actively spreading material in blast mode.
2 properties
2 required
V1ErrorResponse
string
Error message describing why the request failed.
VehicleStatsEngineState
object
Vehicle engine state event.
2 properties
2 required
VehicleStatsResponse_evDistanceDrivenMeters
object
Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
time
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
VehicleStatsAuxInputValue
boolean
Boolean indicating the state of the auxiliary equipment.
VehicleStatsDecorations_ecuSpeedMph
object
1 property
1 required
VehicleStatsEvDistanceDrivenMeters
object
Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEcuSpeedMphValue
number
The speed of the vehicle in miles per hour, as reported by the ECU.
VehicleStatsEvRegeneratedEnergyMicroWh
object
Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
DriverEfficiencyRawDataObjectResponseBody
object
Driver Efficiency raw data. This object is returned when the raw format is specified in dataFormats.
14 properties
4 required
DriverEfficiencyGetDriverEfficiencyByVehiclesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
VehicleStatsResponse_evChargingEnergyMicroWh
object
Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
standardErrorResponse
object
Error response
2 properties
VehicleStatsFuelPercentValue
integer
The engine fuel level in percentage points (e.g. 99, 50, etc).
VehicleStatsFaultCodesOemTroubleCode
object
Proprietary diagnostic trouble code for some OEM vehicles.
4 properties
DriverEfficiencyGetDriverEfficiencyByVehiclesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
VehicleAuxInputName
string
The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view i…
VehicleStatsFaultCodesJ1939TroubleCode
object
Diagnostic trouble code for J1939 vehicles.
9 properties
5 required
VehicleStatsListGps
object
GPS location data for the vehicle.
9 properties
3 required
EngineImmobilizerGetEngineImmobilizerStatesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
VehicleStatsSpreaderPrewetName
object
Name of most recent type of prewet material spread, read from the material spreader.
2 properties
2 required
VehicleStatsFaultCodesJ1939TroubleCodes
array
Diagnostic trouble codes for J1939 vehicles.
VehicleStatsFaultCodesPassengerMonitorStatus
object
Readings from engine sensors
12 properties
VehicleStatsDefLevelMilliPercentWithDecoration
object
The Diesel Exhaust Fluid (DEF) milli percentage reading.
3 properties
2 required
VehiclesListVehiclesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
VehicleStatsAmbientAirTempMilliCWithDecoration
object
Vehicle ambient air temperature reading.
3 properties
2 required
VehicleLocationsResponse_data
object
A vehicle and its most recent location.
3 properties
3 required
UserIdentifierSerial
string
The serial number of the gateway. By default: empty. This can be set to a different gateway's serial number to pair this vehicle with a different gateway.
VehicleModel
string
The Vehicles manufacturing model. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.
VehicleStatsDecorations_gpsDistanceMeters
object
1 property
1 required
VehicleStatsGpsDistanceMetersValue
number
Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
DriverEfficiencyGetDriverEfficiencyByVehiclesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
GoaAttributeTinyResponseBody
object
Attribute properties.
4 properties
VehicleStatsEngineOilPressureKPaWithDecoration
object
Vehicle engine oil pressure reading.
3 properties
2 required
VehicleId
string
The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.
VehicleStatsDecorations_engineStates
object
1 property
1 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody
object
2 properties
2 required
VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius
object
Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsFaultCodesWithDecoration
object
Engine fault codes read from J1939, OBDII, and OEM vehicles.
6 properties
1 required
VehicleStatsEvChargingStatus
object
Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
vehicleStatsAuxInputTime
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
VehicleStatsFaultCodesValue_obdii_monitorStatus
object
Readings from engine sensors
12 properties
VehicleStatsEngineImmobilizerWithDecoration
object
Data for the engine immobilizer
4 properties
3 required
VehicleStatsIntakeManifoldTempMilliC
object
Vehicle intake manifold temperature reading.
2 properties
2 required
vehicleSensorConfigurationAreaResponseBody
object
A configured sensor area on the vehicle with its associated sensors
4 properties
1 required
VehicleYear
string
Year of the Vehicle.
VehicleStatsNfcCardScan_card
object
The card that was scanned.
1 property
EngineImmobilizerGetEngineImmobilizerStatesResponseBody
object
2 properties
2 required
TachographVehicleFile
object
Tachograph vehicle file
4 properties
VehiclesDriverAssignmentsObjectResponseBody
object
4 properties
2 required
paginationResponse
object
Pagination parameters.
2 properties
2 required
VehicleStatsEngineLoadPercentValue
integer
The engine load in percentage points (e.g. 99, 50, etc).
VehicleStatsEngineRpmValue
integer
The revolutions per minute of the engine.
VehicleStatsSeatbeltDriver
object
Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled.
2 properties
2 required
GoaDriverTinyResponseResponseBody
object
A minified driver object. This object is only returned if the route is assigned to the driver.
3 properties
1 required
VehicleStatsResponse_spreaderRoadTemp
object
Road temperature reading in milli celsius from material spreader.
2 properties
2 required
VehicleStatsSpreaderGranularName
object
Name of most recent type of granular material spread, read from the material spreader.
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
CameraSerial
string
The serial number of the camera installed in the vehicle
VehicleStatsNfcCardScanWithDecoration
object
Data for the nfc card and the time that it was scanned.
3 properties
2 required
VehicleStatsEngineStateWithDecoration
object
Vehicle engine state event.
3 properties
2 required
EngineImmobilizerRelayStateResponseBody
object
An engine immobilizer relay state.
2 properties
2 required
VehicleStatsResponse_evConsumedEnergyMicroWh
object
Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsResponse_spreaderGranularRate
object
Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader u…
2 properties
2 required
VehicleStatsEngineImmobilizer
object
Data for the engine immobilizer
3 properties
3 required
VehicleLicensePlate
string
The license plate of the Vehicle. By default: empty. Can be set or updated through the Samsara Dashboard or the API at any time.
VehicleStatsListResponse
object
List of vehicle stat events and pagination info.
2 properties
2 required
VehicleStatsSpreaderGranularRate
object
Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader u…
2 properties
2 required
VehicleStatsSpreaderLiquidRate
object
Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsResponse_spreaderLiquidRate
object
Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsResponse_spreaderActive
object
Whether vehicle is actively spreading any material.
2 properties
2 required
V1VehicleSafetyScoreResponse
object
Safety score details for a vehicle
12 properties
VehicleStatsFaultCodesOemTroubleCodes
array
Proprietary diagnostic trouble codes for OEM vehicles.
VehicleStatsResponse_spreaderGranularName
object
Name of most recent type of granular material spread, read from the material spreader.
2 properties
2 required
VehicleStatsResponse_evBatteryCurrentMilliAmp
object
Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
TachographVehicleFileData
array
VehicleStatsDecorations_engineRpm
object
1 property
1 required
VehicleStatsDefLevelMilliPercent
object
The Diesel Exhaust Fluid (DEF) milli percentage reading.
2 properties
2 required
EngineImmobilizerGetEngineImmobilizerStatesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
VehicleLocationsResponse
object
Most recent vehicle locations and pagination info.
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
VehicleStatsGpsOdometerMetersValue
integer
Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.
VehicleStatsResponse_spreaderPrewetName
object
Name of most recent type of prewet material spread, read from the material spreader.
2 properties
2 required
GrossVehicleWeight
object
The gross weight of the vehicle in either pounds (lb) or kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled.
2 properties
VehicleHarshAccelerationSettingType
string
The harsh acceleration setting type. This setting influences the acceleration sensitivity from which a harsh event is triggered. By default, this setting is in…
VehicleStatsDecorations_barometricPressurePa
object
1 property
1 required
VehicleLocationLongitude
number
GPS longitude represented in degrees
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
VehicleStatsObdEngineSeconds
object
Vehicle OBD engine seconds reading.
2 properties
2 required
UpdateVehicleRequest
object
All the editable portions of the vehicle object.
28 properties
VehicleResponse
object
A single vehicle.
1 property
1 required
tagTinyResponse
object
A minified tag object
3 properties
VehicleStatsDecorations_defLevelMilliPercent
object
1 property
1 required
DriverEfficiencyGetDriverEfficiencyByVehiclesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
VehicleStatsFaultCodesIgnitionType
string
The ignition type of this passenger vehicle. Valid values: spark, compression.
VehicleLocation
object
Vehicle location event.
6 properties
3 required
VehicleStatsResponse_spreaderOnState
object
Whether vehicle spreader is enabled.
2 properties
2 required
VehicleStatsEvChargingCurrentMilliAmp
object
Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
EngineImmobilizerGetEngineImmobilizerStatesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
vehicleSensorConfigurationResponseBody
object
The sensors configured on a vehicle
2 properties
VehicleStatsListSyntheticEngineSeconds
object
A list of synthetic engine seconds for the vehicle.
3 properties
2 required
VehicleStatsEvChargingEnergyMicroWh
object
Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
vehicleSensorConfigurationDoorResponseBody
object
A door monitor configuration on a vehicle
2 properties
2 required
GoaGatewayTinyResponseResponseBody
object
A minified gateway object
2 properties
2 required
DriverEfficiencyPercentageDataObjectResponseBody
object
Driver Efficiency percentage data. This object is returned when the percentage format is specified in dataFormats.
9 properties
1 required
VehicleTags
array
The list of tags associated with the Vehicle. By default: empty. Can be set or updated through the Samsara Dashboard or the API at any time.
VehicleStatsGpsOdometerMeters
object
Vehicle GPS odometer event.
2 properties
2 required
VehicleStatsResponse
object
Vehicle stats snapshot and pagination info.
2 properties
2 required
VehicleStatsFaultCodesOBDII
object
Vehicle fault codes for passenger vehicles.
2 properties
VehiclesListVehiclesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
VehicleStatsGps
object
GPS location data for the vehicle.
8 properties
3 required
VehicleStatsEvBatteryStateOfHealthMilliPercent
object
Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsDecorations_gpsOdometerMeters
object
1 property
1 required
VehicleStatsSyntheticEngineSeconds
object
Data for the synthetic engine seconds for the vehicle
3 properties
2 required
VehicleLocationHeading
number
Heading of the vehicle in degrees.
VehicleStatsFaultCodesJ1939Lights
object
Status of engine lights on J1939 vehicles.
4 properties
4 required
VehicleStatsResponse_spreaderLiquidName
object
Name of most recent type of liquid material spread, read from the material spreader.
2 properties
2 required
reverseGeo
object
Reverse geocoded information.
1 property
VehicleStatsBarometricPressurePaWithDecoration
object
Vehicle barometric pressure reading.
3 properties
2 required
VehicleStatsFaultCodesValue_oem
object
Vehicle fault codes for OEM vehicles.
1 property
VehicleStatsFaultCodesPassengerMonitorStatusValue
string
Enum of monitor status: -U: Unsupported -N: Not Complete -R: Complete
VehicleStatsFaultCodesCanBusType
string
The CAN bus type of the vehicle.
VehicleStatsDecorations_fuelPercents
object
1 property
1 required
EngineImmobilizerGetEngineImmobilizerStatesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
VehiclesListVehiclesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
VehicleStatsAuxInput
object
Data for auxiliary digio equipment.
3 properties
sensorResponseBody
object
A sensor
3 properties
3 required
attributeTiny
object
A minified attribute.
4 properties
VehicleAuxInputType
string
The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view i…
Vehicle
object
The vehicle object.
34 properties
1 required
VehicleStatsResponse_evChargingCurrentMilliAmp
object
Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsAuxInputDecoration
object
2 properties
2 required
VehicleStatsEcuSpeedMphWithDecoration
object
The speed of the vehicle in miles per hour, as reported by the ECU.
3 properties
2 required
VehicleStatsEngineRpm
object
Vehicle engine RPM reading.
2 properties
2 required
VehicleStatsSpreaderAirTemp
object
Air (ambient) temperature in milli celsius reading from material spreader.
2 properties
2 required
VehicleExternalIds
object
The external IDs for the given object.
EngineImmobilizerGetEngineImmobilizerStatesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
VehicleStatsEvBatteryCurrentMilliAmp
object
Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
VehiclesListVehiclesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
EngineImmobilizerStateResponseBody
object
An engine immobilizer state.
4 properties
4 required
VehicleStatsBarometricPressurePa
object
Vehicle barometric pressure reading.
2 properties
2 required
VehicleStatsResponse_evRegeneratedEnergyMicroWh
object
Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsFaultCodesValue_obdii_confirmedDtcs
object
Passenger vehicle DTC information
3 properties
1 required
VehicleStatsFaultCodesOBDIITroubleCode
object
Diagnostic trouble code for passenger vehicles.
7 properties
1 required
DriverAssignmentObjectResponseBody
object
5 properties
VehicleStatsResponse_evBatteryStateOfHealthMilliPercent
object
Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsAmbientAirTempMilliCValue
integer
The ambient air temperature reading in millidegree Celsius.
V1VehicleHarshEventResponse_location
object
3 properties
VehicleStatsResponse_evStateOfChargeMilliPercent
object
State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
VehicleStatsFaultCodesOem
object
Vehicle fault codes for OEM vehicles.
1 property
VehicleStatsResponse_spreaderAirTemp
object
Air (ambient) temperature in milli celsius reading from material spreader.
2 properties
2 required
VehicleStatsFaultCodes
object
Engine fault codes read from J1939, OBDII, and OEM vehicles.
5 properties
1 required
VehicleStatsSpreaderRoadTemp
object
Road temperature reading in milli celsius from material spreader.
2 properties
2 required
VehicleStatsAuxInputWithDecoration
object
Data for auxiliary digio equipment.
4 properties
VehicleStatsEngineStateSetting
string
The state of the engine.
GoaTagTinyResponseResponseBody
object
A minified tag object
3 properties
2 required
vehicleTinyResponse
object
A minified vehicle object.
3 properties
VehicleStatsDecorations_intakeManifoldTemperatureMilliC
object
1 property
1 required
singleDriverEfficiencyByVehicleDataObjectResponseBody
object
singleDriverEfficiencyByVehicleDataObject
5 properties
1 required
VehicleType
string
The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled.
VehiclesListVehiclesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
Sensor
object
3 properties
3 required
VehicleSensorConfiguration
object
The sensors configured on a vehicle
2 properties
VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes
object
Diagnostic trouble code for passenger vehicles.
7 properties
1 required
VehicleStatsObdEngineSecondsWithDecoration
object
Vehicle OBD engine seconds reading.
3 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
VehicleStatsEvChargingVoltageMilliVolt
object
Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleSensorConfigurationArea
object
The sensor configuration for an area of the vehicle
4 properties
VehicleVin
string
The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it canno…
VehiclesListVehiclesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TachographVehicleFilesResponse
object
List of all vehicle tachograph files in a specified time range.
2 properties
VehicleStatsResponse_evBatteryVoltageMilliVolt
object
Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
Serial
string
The serial number of the gateway installed in the vehicle.
VehiclesListVehiclesResponseBody
object
2 properties
2 required
VehicleStatsEvBatteryVoltageMilliVolt
object
Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
EngineImmobilizerGetEngineImmobilizerStatesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
VehicleStatsSpreaderActive
object
Whether vehicle is actively spreading any material.
2 properties
2 required
gatewayTiny
object
A minified gateway including serial number and model.
2 properties
VehicleStatsBatteryMilliVoltsValue
integer
The battery voltage in millivolts.
VehicleStatsEvConsumedEnergyMicroWh
object
Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsGpsDistanceMetersWithDecoration
object
Vehicle GPS distance event.
3 properties
2 required
V1SafetyReportHarshEvent
object
List of harsh events
3 properties
VehicleStatsFaultCodesValue_j1939
object
Vehicle fault codes for J1939 vehicles.
2 properties
V1VehicleHarshEventResponse
object
Harsh event details for a vehicle
7 properties
2 required
VehicleStatsBatteryVoltageWithDecoration
object
Vehicle battery voltage reading.
3 properties
2 required
VehicleStatsResponse_spreaderPrewetRate
object
Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsNfcCardScan
object
Data for the nfc card and the time that it was scanned.
2 properties
2 required
VehiclesListVehiclesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
driverTinyResponse
object
A minified driver object.
2 properties
VehicleLocationSpeed
number
GPS speed of the vehicle in miles per hour. See isEcuSpeed to determine speed data source.
VehicleStatsSpreaderPrewetRate
object
Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsIntakeManifoldTempMilliCWithDecoration
object
Vehicle intake manifold temperature reading.
3 properties
2 required
VehicleStatsResponse_evChargingStatus
object
Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEngineOilPressureKPa
object
Vehicle engine oil pressure reading.
2 properties
2 required
VehicleStatsEngineCoolantTempMilliCWithDecoration
object
Vehicle engine coolant temperature reading.
3 properties
2 required
VehicleStatsResponse_seatbeltDriver
object
Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled.
2 properties
2 required
VehicleStatsFuelPercent
object
Vehicle fuel percentage reading.
2 properties
2 required
VehicleStatsSpreaderLiquidName
object
Name of most recent type of liquid material spread, read from the material spreader.
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
VehicleStatsDecorations_gps
object
7 properties
2 required
VehicleStatsFuelPercentWithDecoration
object
Vehicle fuel percentage reading.
3 properties
2 required
VehicleStatsFaultCodesVendorSpecificFields
object
Vendor specific data for J1939 vehicles.
2 properties
VehicleStatsGpsOdometerMetersWithDecoration
object
Vehicle GPS odometer event.
3 properties
2 required
DriverEfficiencyDifficultyScoreDataObjectResponseBody
object
Difficulty score won't be available if there is no data to compute it against.
3 properties
VehicleSensorConfigurationDoor
object
A door monitor configuration for a vehicle
2 properties
VehicleNotes
string
These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.
VehicleStatsDecorations
object
Optional decorations to the primary stat event. See [here](doc:decorations) for more details. The example shows the response if you were to submit decorations=…
58 properties
VehicleName
string
The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mob…
VehicleRegulationMode
string
Whether or not the vehicle is regulated, unregulated (non-CMV), or a mixed use unregulated vehicle. Valid values: regulated, unregulated, mixed.
VehicleLocationLatitude
number
GPS latitude represented in degrees
VehicleStatsEngineOilPressureKPaValue
integer
The engine oil pressure reading in kilopascals.
VehicleStatsEngineRpmWithDecoration
object
Vehicle engine RPM reading.
3 properties
2 required
VehicleStatsFaultCodesTxId
integer
The TX identifier.
VehiclesListVehiclesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
VehicleStatsFaultCodesJ1939
object
Vehicle fault codes for J1939 vehicles.
2 properties
VehicleStatsEngineCoolantTempMilliC
object
Vehicle engine coolant temperature reading.
2 properties
2 required
VehicleStatsSpreaderPlowStatus
object
Snow plow status (Up or Down), as read from the material spreader. Note: this is separate from plow status defined via auxInput.
2 properties
2 required
EngineImmobilizerGetEngineImmobilizerStatesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
VehicleStatsIntakeManifoldTempMilliCValue
integer
The intake manifold temperature reading in millidegree Celsius.
EngineImmobilizerGetEngineImmobilizerStatesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
VehicleStatsObdOdometerMetersValue
integer
Number of meters the vehicle has traveled according to the on-board diagnostics.
VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes
object
Proprietary diagnostic trouble code for some OEM vehicles.
4 properties
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes
object
Diagnostic trouble code for J1939 vehicles.
9 properties
5 required
VehicleStatsResponse_data
object
A vehicle and its most recent stat.
62 properties
2 required
VehicleStatsFaultCodesValue_j1939_vendorSpecificFields
object
Vendor specific data for J1939 vehicles.
2 properties
DriverEfficiencyGetDriverEfficiencyByVehiclesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
VehicleStatsObdEngineSecondsValue
integer
Number of seconds the vehicle's engine has been on according to the on-board diagnostics.
DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody
object
2 properties
2 required
VehiclesListVehiclesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
VehicleStatsDecorations_batteryMilliVolts
object
1 property
1 required
DriverEfficiencyGetDriverEfficiencyByVehiclesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
VehicleStatsEvAverageBatteryTemperatureMilliCelsius
object
Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsSyntheticEngineSecondsValue
integer
Stats for the number of seconds the vehicle's engine has been on, calculated based on a manually-specified engine seconds reading and the number of seconds the…
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
VehiclesListVehiclesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
VehicleMake
string
The Vehicles manufacturing make. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.
VehicleLocationsListResponse
object
List of vehicle location events and pagination info.
2 properties
2 required
VehicleStatsEcuSpeedMph
object
The speed of the vehicle in miles per hour, as reported by the ECU.
2 properties
2 required
VehicleStatsFaultCodesPassengerDtc
object
Passenger vehicle DTC information
3 properties
1 required
VehicleLocationsListResponse_data
object
A vehicle and its list of location events.
3 properties
3 required
VehicleStatsDecorations_engineCoolantTemperatureMilliC
object
1 property
1 required
VehicleStatsDefLevelMilliPercentValue
integer
The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. 99001, 49999, etc).
VehicleStatsFaultCodesValue_obdii
object
Vehicle fault codes for passenger vehicles.
2 properties
VehicleStatsDecorations_obdOdometerMeters
object
1 property
1 required
VehicleStatsTirePressures
object
Tire pressure readings for each of four tires in kilopascals.
4 properties
VehicleResponseObjectResponseBody
object
A single vehicle
38 properties
2 required
VehicleStatsDecorations_engineLoadPercent
object
1 property
1 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverEfficiencyDataObjectResponseBody
object
Driver Efficiency score data. This object is returned by default or when the score format is specified in dataFormats.
9 properties
1 required
EngineImmobilizerGetEngineImmobilizerStatesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
VehicleStatsDecorations_ambientAirTemperatureMilliC
object
1 property
1 required
VehicleStatsFaultCodesValue
object
Fault codes for the vehicle
4 properties
DriverObjectResponseBody
object
Current driver of the vehicle. Note: this parameter includes all assignment sources, not just static assignments.
2 properties
VehicleStatsEngineLoadPercent
object
The engine load percentage reading.
2 properties
2 required
TachographVehicleFileListWrapper
object
2 properties
VehicleStatsObdOdometerMeters
object
Vehicle OBD odometer reading.
2 properties
2 required
VehicleEsn
string
Engine serial number.
VehicleStatsDecorations_obdEngineSeconds
object
1 property
1 required
VehicleStatsObdOdometerMetersWithDecoration
object
Vehicle OBD odometer reading.
3 properties
2 required
VehicleStatsListResponse_data
object
A vehicle and its list of stat events.
62 properties
VehicleStatsSpreaderBlastState
object
Whether vehicle is actively spreading material in blast mode.
2 properties
2 required
VehicleStatsDecorations_engineOilPressureKPa
object
1 property
1 required
VehicleStatsGpsDistanceMeters
object
Vehicle GPS distance event.
2 properties
2 required
VehicleStatsSpreaderOnState
object
Whether vehicle spreader is enabled.
2 properties
2 required
VehicleStatsBarometricPressurePaValue
integer
The barometric pressure reading in pascals.
EngineImmobilizerGetEngineImmobilizerStatesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
VehicleLocationIsEcuSpeed
boolean
True if the speed value is reported from the ECU. Speed value is reported from GPS otherwise.
VehicleLocationAddress
object
Address that the location is in.
2 properties
VehicleStatsEngineCoolantTempMilliCValue
integer
The engine coolant temperature reading in millidegree Celsius.
VehicleStatsAmbientAirTempMilliC
object
Vehicle ambient air temperature reading.
2 properties
2 required
TachographVehicleFileList
array
List of all tachograph vehicle files in a specified time range.
VehicleStatsResponse_evChargingVoltageMilliVolt
object
Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsBatteryVoltage
object
Vehicle battery voltage reading.
2 properties
2 required
VehicleStatsEvStateOfChargeMilliPercent
object
State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
VehicleStatsFaultCodesValue_j1939_checkEngineLights
object
Status of engine lights on J1939 vehicles.
4 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Samsara 12
Other APIs Samsara publishes across the network.
Samsara Activity API
Samsara Addresses API
Samsara Aemp API
Samsara Applications API
Samsara Assets API
Samsara Assignments API
Samsara Attributes API
Samsara Audit API
Samsara Beta A P Is API
Samsara Camera API
Samsara Cameras API
Samsara Cargo API
#Vehicles
Where this information came from
This is an independent, third-party profile of Samsara Vehicles 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.