Samsara Drivers API
The Drivers API from Samsara — 9 operation(s) for drivers.
Samsara Drivers API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Drivers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 11 operations across 9 paths, and defines 114 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/.
11 operations
9 paths
114 schemas
8 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Drivers API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 11
Across 9 paths, the API surfaces 11 operations — 8 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Drivers 11
GET
/beta/fleet/hos/drivers/eld-events
[beta] Get Driver HOS ELD Events
GET
/fleet/drivers
List All Drivers
POST
/fleet/drivers
Create a Driver
GET
/fleet/drivers/tachograph-activity/history
Get Driver Tachograph Activity
GET
/fleet/drivers/tachograph-files/history
Get Tachograph Driver Files
GET
/fleet/drivers/vehicle-assignments
[legacy] Get All Vehicles Assigned to a Set of Drivers
GET
/fleet/drivers/{id}
Retrieve a Driver
PATCH
/fleet/drivers/{id}
Update a Driver
GET
/preview/driver-efficiency/drivers
[preview] Get Driver Efficiency Data Grouped by Drivers.
GET
/v1/fleet/drivers/{driverId}/safety/score
Fetch Driver Safety Score
POST
/v1/fleet/drivers/{driver_id}/hos/duty_status
Set a Duty Status for a Specific Driver
Schemas 114
The contract defines 114 schemas that model the data the API accepts and returns. The most detailed are Driver (33 properties), UpdateDriverRequest (31 properties), CreateDriverRequest (29 properties), DriverEfficiencyRawDataObjectResponseBody (14 properties). Each schema is shown below with its type and property counts.
HosEldEventsGetHosEldEventsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
ListDriversResponse
object
A list of drivers.
2 properties
V1ErrorResponse
string
Error message describing why the request failed.
HosEldEventsGetHosEldEventsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverIsDeactivated
boolean
[DEPRECATED] A boolean indicating whether or not the driver is deactivated. Use driverActivationStatus instead.
DriverEfficiencyRawDataObjectResponseBody
object
Driver Efficiency raw data. This object is returned when the raw format is specified in dataFormats.
14 properties
4 required
Driver
object
A driver object
33 properties
DriverName
string
Driver's name.
DriverEfficiencyGetDriverEfficiencyByDriversInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
standardErrorResponse
object
Error response
2 properties
DriverUsername
string
Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.
TachographDriverFileListWrapper
object
2 properties
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
DriversVehicleAssignmentsGetDriversVehicleAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverResponse
object
A single driver.
1 property
DriverTachographActivityResponse
object
List of all driver tachograph activities in a specified time range.
2 properties
DriverEldRulesetJurisdiction
string
The jurisdiction of the ELD ruleset applied to this driver. These are specified by either CS or CN for Canada South and Canada North, respectively, or the ISO…
DriverTachographCardNumber
string
Driver's assigned tachograph card number (Europe specific)
DriverEfficiencyGetDriverEfficiencyByDriversNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverTachographActivityData
array
DriverEfficiencyGetDriverEfficiencyByDriversGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
paginationResponse
object
Pagination parameters.
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
singleDriverEfficiencyByDriverDataObjectResponseBody
object
singleDriverEfficiencyByDriverDataObject
5 properties
1 required
DriverEldBigDayExemptionEnabled
boolean
Flag indicating this driver may use Big Day exemption in ELD logs.
HosEldEventsGetHosEldEventsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverHasDrivingFeaturesHidden
boolean
A boolean indicating whether the driver has driving-related features hidden in the Driver App, including Vehicle selection, HOS, Routing, Team Driving, Documen…
DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriversVehicleAssignmentsObjectResponseBody
object
5 properties
4 required
DriverEfficiencyGetDriverEfficiencyByDriversServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
HosEldEventObjectResponseBody
object
An event that refers to a discrete instance in time with various data elements. Depending on the type of event, not every field will be populated. For more inf…
13 properties
3 required
TachographDriverFile
object
Tachograph driver file
4 properties
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
tagTinyResponse
object
A minified tag object
3 properties
TachographActivityList
array
List of all driver tachograph activities in a specified time range.
V1DriverSafetyScoreResponse
object
Safety score details for a driver
12 properties
DriverEfficiencyGetDriverEfficiencyByDriversUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverPhone
string
Phone number of the driver.
DriverEfficiencyPercentageDataObjectResponseBody
object
Driver Efficiency percentage data. This object is returned when the percentage format is specified in dataFormats.
9 properties
1 required
HosEldEventsGetHosEldEventsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TachographActivityListWrapper
object
2 properties
DriverId
string
Samsara ID for the driver.
DriverExternalIds
object
The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.
DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
HosEldEventsGetHosEldEventsResponseBody
object
2 properties
1 required
attributeTiny
object
A minified attribute.
4 properties
DriverEldYmEnabled
boolean
Flag indicating this driver may select the Yard Move duty status in ELD logs.
DriverEldSettings
object
The driver's ELD settings.
1 property
DriverEldDayStartHour
integer
0 indicating midnight-to-midnight ELD driving hours, 12 to indicate noon-to-noon driving hours.
UpdateDriverRequest
object
Driver that should be updated.
31 properties
DriverEldAdverseWeatherExemptionEnabled
boolean
Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
DriverTags
array
The tags this driver belongs to.
HosEldEventsGetHosEldEventsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
HosEldEventRemarkObjectResponseBody
object
3 properties
3 required
DriverUpdatedAtTime
string
The date and time this driver was last updated in RFC 3339 format.
DriverIdCardCode
string
The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.
DriverVehicleGroupTag
object
Tag which determines which vehicles a driver will see when selecting vehicles.
3 properties
DriverCreatedAtTime
string
The date and time this driver was created in RFC 3339 format.
UpdateDriverRequest_hosSetting
object
Hos settings for a driver.
1 property
HosEldEventsGetHosEldEventsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverWaitingTimeDutyStatusEnabled
boolean
Flag indicating this driver may select waiting time duty status in ELD logs.
DriverEfficiencyGetDriverEfficiencyByDriversNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
CreateDriverRequest_attributes
object
A minified attribute.
4 properties
DriverHeavyHaulExemptionToggleEnabled
boolean
Flag indicating this driver may use the Heavy Haul exemption in ELD logs.
DriverLicenseState
string
Abbreviation of US state, Canadian province, or US territory that issued driver's license.
DriversVehicleAssignmentsGetDriversVehicleAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverNotes
string
Notes about the driver.
DriverLocale
string
Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: us, at, be, ca, gb, fr, de, ie, it, lu, mx, nl…
DriversVehicleAssignmentsGetDriversVehicleAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverEldExemptReason
string
Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).
DriverCarrierSettings
object
Carrier for a given driver. If the driver's carrier differs from the general organization's carrier settings, the override value is used. Updating this value o…
5 properties
TachographDriverFilesResponse
object
List of all driver tachograph files in a specified time range.
2 properties
DriverEldRulesetRestBreak
string
The rest break required setting of the ELD ruleset applied to this driver. Valid values: Property (off-duty/sleeper), Explosives/HazMat (on-duty)
V1SafetyReportHarshEvent
object
List of harsh events
3 properties
HosEldEventsGetHosEldEventsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TachographDriverFileList
array
List of all tachograph driver files in a specified time range.
DriverEldRulesetCycle
string
The cycle of the ELD ruleset applied to this driver. Valid values: USA 60 hour / 7 day, USA 70 hour / 8 day, AK 80 hour / 8 day, AK 70 hour / 7 day, CA 80 hour…
DriverHomeTerminalName
string
Name of the place of business at which a driver ordinarily reports for work.
driverTinyResponse
object
A minified driver object.
2 properties
DriverEldExempt
boolean
Flag indicating this driver is exempt from the Electronic Logging Mandate.
DriverEldRulesets
array
The driver's ELD rulesets and overrides. This is the full set of rulesets that may apply to the driver depending on their activity. If you wish to interface wi…
DriverHosSetting
object
Hos settings for a driver.
1 property
DriverEldRulesetRestart
string
The restart of the ELD ruleset applied to this driver. Valid values: None, 34-hour Restart, 24-hour Restart, 36-hour Restart, 72-hour Restart.
DriverEfficiencyDifficultyScoreDataObjectResponseBody
object
Difficulty score won't be available if there is no data to compute it against.
3 properties
DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
HosDriversEldEventObjectResponseBody
object
5 properties
4 required
HosEldEventsGetHosEldEventsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
HosEldEventsGetHosEldEventsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverTimezone
string
Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use [IANA timezone database](https://www…
DriverLicenseNumber
string
Driver's state issued license number. The combination of this number and licenseState must be unique.
inline_object_1
object
5 properties
1 required
DriverEfficiencyGetDriverEfficiencyByDriversTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TachographDriverFileData
array
DriverEfficiencyGetDriverEfficiencyByDriversResponseBody
object
2 properties
2 required
DriverHomeTerminalAddress
string
Address of the place of business at which a driver ordinarily reports for work.
HosEldEventLocationObjectResponseBody
object
5 properties
DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody
object
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverEldRuleset
object
An ELD ruleset for a driver.
5 properties
DriverActivationStatus
string
A value indicating whether the driver is active or deactivated. Valid values: active, deactivated.
DriverEldPcEnabled
boolean
Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.
VehicleAssignmentObjectResponseBody
object
5 properties
4 required
UsDriverRulesetOverride
object
US Driver Ruleset override for a given driver. If the driver is operating under a ruleset different from the organization default, the override is used. Updati…
4 properties
4 required
DriverStaticAssignedVehicle
object
Vehicle assigned to the driver for static vehicle assignments. (uncommon).
2 properties
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
DriverEldRulesetShift
string
The shift of the ELD ruleset applied to this driver. Valid values: US Interstate Property, US Interstate Passenger, Texas Intrastate.
DriversVehicleAssignmentsGetDriversVehicleAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
CreateDriverRequest
object
Driver that should be created.
29 properties
3 required
DriverEfficiencyGetDriverEfficiencyByDriversBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
HosEldEventsGetHosEldEventsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TachographActivity
object
Tachograph activity
4 properties
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
#Drivers
Where this information came from
This is an independent, third-party profile of Samsara Drivers 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.