REST API Overview
Learn about the main resources available through Samsara's API
Get GPS and on-board diagnostic data. You can create integrations that synchronize telematics data into your application, or you can pull ad-hoc reports. See the Telematics guide for an overview of available query patterns and diagnostics.
Samsara provides different telematics devices for different types of assets. Here's a breakdown of how Samsara classifies different types of assets and the APIs relevant to each type:
|Asset Type||Relevant APIs|
|Vehicles: VG34 and VG54|
Cellular vehicle gateway with GPS and CAN bus interface.
- Vehicle Stats
|Equipment: AG26 attached via APWR, CAT, or J1939 cable|
|Trailers: AG26 attached via a 7-way cable||- Assets|
|Reefers: AG26 attached to a refrigerated trailer||- Assets|
|Unpowered Assets: AG46|
Unpowered and low-cost assets
Drivers can be created and managed through both the Samsara dashboard and the API. A driver entity will contain all the metadata relevant to that driver:
- Basic information such as name, phone number, and license
- Driver App login information
- ELD settings
- Other driver settings
Full create, read, and update operations are available for drivers through the API. See the Drivers for full documentation.
Drivers cannot be deleted (for ELD compliance reasons). They can only be "deactivated". See the
driverActivationStatusfield in the Drivers API for details on working with active vs deactivated drivers, and how to change that field as needed.
Samsara provides you the ability to create routes that are automatically tracked using the Samsara Vehicle Gateway. The Routing APIs allow you to create, read, update, and delete route plans so that you can sync them with your own applications. Additionally, you can also use the APIs and webhooks to track route progress, provide ETAs, and live-share links to your end customers. See the Routing API guide for details.
Compliance & ELD
Samsara provides a complete ELD compliance system that allows you to track drivers' hours of service and duty status. See the Compliance & ELD guide for details on different use cases.
The Addresses API allows you to manage known locations for use in routes, time-on-site reports, and more. You can create, read, update, and delete these known locations and configure their custom geofences. Check out the Addresses API guide for more details.
The Samsara platform allows you to create and manage DVIRs through the Samsara Driver App and Dashboard. Additionally, the DVIRs APIs allows you to create, read, update, and resolve DVIRs programmatically for integration with your other preventative maintenance applications.
Samsara provides the ability to organize your data using Tags. Tags can represent different regions, departments, or other organizational structure. Tags can also be hierarchical (e.g. the "Houston Branch" tag may be nested under the "Texas" tag). You can programmatically manage tags using the Tags API. When retrieving most data via the API, you can filter by tags as well.
Samsara's Documents feature allows you to customize driver workflow through custom forms that drivers fill out using the Driver App. Fleet administrators can design form templates using text, number, multiple-choice, date-time, photo, and signature fields. You can use the Documents API and webhooks to create documents for drivers to fill out, capture submitted documents, and download document PDFs. You can also associate documents with route stops as a driver task for that stop.
The Samsara Dashboard and Driver App provide the capability for fleet admins and drivers to exchange messages. The Messages API also allows you to send messages to drivers on behalf of a fleet admin and read all messages.
The Users API allows you to manage administrators and administrator privileges for your Samsara organization.
Samsara's platform allows you to track safe driving. You can retrieve a list of safety-related driving events and pull safety scores at the driver or vehicle level via the Safety API.
Samsara provides various different types of environmental sensors to augment the data provided by IoT gateways. Examples include temperature, humidity, door, and cargo monitors. You can retrieve data from these sensors using the Sensors API.
Updated over 1 year ago