Samsara Driver API
The Driver API from Samsara — 4 operation(s) for driver.
Samsara Driver API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Driver. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 8 operations across 4 paths, and defines 108 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/.
8 operations
4 paths
108 schemas
1 DELETE4 GET1 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Driver API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 8
Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Driver 8
GET
/coaching/driver-coach-assignments
Get Driver Coach Assignments.
PUT
/coaching/driver-coach-assignments
Put Driver Coach Assignments.
DELETE
/fleet/driver-vehicle-assignments
Delete API Generated Driver-vehicle Assignments
GET
/fleet/driver-vehicle-assignments
Get All Driver-vehicle Assignments
PATCH
/fleet/driver-vehicle-assignments
Update API Generated Driver-vehicle Assignments
POST
/fleet/driver-vehicle-assignments
Create a New Driver-vehicle Assignment
GET
/preview/driver-efficiency/drivers
[preview] Get Driver Efficiency Data Grouped by Drivers.
GET
/preview/driver-efficiency/vehicles
[preview] Get Driver Efficiency Data Grouped by Vehicles.
Schemas 108
The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are DriverEfficiencyRawDataObjectResponseBody (14 properties), DriverEfficiencyDataObjectResponseBody (9 properties), DriverEfficiencyPercentageDataObjectResponseBody (9 properties), DriverVehicleAssignmentV2ObjectResponseBody (8 properties). Each schema is shown below with its type and property counts.
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody
object
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
DriverEfficiencyGetDriverEfficiencyByDriversInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody
object
1 property
1 required
DriverCoachAssignmentsGetDriverCoachAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverAssignmentMetadataTinyObjectResponseBody
object
Metadata object for external assignment source data.
1 property
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
DriverEfficiencyGetDriverEfficiencyByVehiclesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody
object
1 property
1 required
DriverCoachAssignmentsPutDriverCoachAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
singleDriverEfficiencyByDriverDataObjectResponseBody
object
singleDriverEfficiencyByDriverDataObject
5 properties
1 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody
object
Driver Assignment to be created
7 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
DriverCoachAssignmentsGetDriverCoachAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentV2ObjectResponseBody
object
Object with driver assignment info and associated driver and vehicle info.
8 properties
4 required
DriverEfficiencyGetDriverEfficiencyByDriversServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
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
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentResponseBody
object
1 property
1 required
DriverCoachAssignmentsPutDriverCoachAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
CoachAssignmentWithoutDriverExternalIdsResponseResponseBody
object
Driver coach assignment object.
4 properties
3 required
DriverCoachAssignmentsGetDriverCoachAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
singleDriverEfficiencyByVehicleDataObjectResponseBody
object
singleDriverEfficiencyByVehicleDataObject
5 properties
1 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
PostDriverVehicleAssignmentsV2ResponseBodyResponseBody
object
Response after successfully submitting a Driver Assignment
1 property
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentResponseBody
object
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverEfficiencyDifficultyScoreDataObjectResponseBody
object
Difficulty score won't be available if there is no data to compute it against.
3 properties
DriverCoachAssignmentsGetDriverCoachAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
PostDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody
object
Metadata about this driver assignment
1 property
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody
object
Updated Driver Assignment details
7 properties
3 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody
object
Driver assignments to be deleted
5 properties
1 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
PatchDriverVehicleAssignmentsV2ResponseBodyResponseBody
object
Response after successfully updating a Driver Assignment
1 property
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversResponseBody
object
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody
object
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
PatchDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody
object
Metadata about this driver assignment
1 property
DriverCoachAssignmentsPutDriverCoachAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotFoundErrorResponseBody
object
Resource not found
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
DriverCoachAssignmentsGetDriverCoachAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverWithExternalIdObjectResponseBody
object
A driver object with an id and map of external ids.
2 properties
1 required
DriverCoachAssignmentsPutDriverCoachAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
CoachAssignmentWithDriverExternalIdsResponseResponseBody
object
Driver coach assignment object.
4 properties
4 required
DriverCoachAssignmentsGetDriverCoachAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByDriversBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverEfficiencyGetDriverEfficiencyByVehiclesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 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
#Driver
Where this information came from
This is an independent, third-party profile of Samsara Driver 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.