License Requirements for APIs and Webhook Access
Some APIs and integrations require a specific Samsara license to use all of the features. See Samsara Pricing & Packaging Plans to compare different plans and tiers.
Use this page to make sure your organization has the minimum required licenses for your planned API usage.
API Endpoints Access
A specific license is required to access these API endpoints. This table lists which plan your organization needs to access the API.
| Endpoint | Minimum Required Plan |
|---|---|
| defects/stream defect-types fleet/defects/history fleet/defects | Telematics - Essential |
| dvirs/stream fleet/dvirs fleet/dvirs/history | Telematics - Essential |
| fleet/documents fleet/document-types fleet/documents/pdfs | Telematics - Essential |
| fleet/drivers/efficiency | Telematics - Premier |
| fleet/drivers/tachograph-files/history | Telematics - Premier |
| fleet/hos/daily-logs | Telematics - Essential Plus |
| fleet/hos/diagnostic-and-malfunction-events | Telematics - Essential Plus |
| fleet/hos/drivers/eld-events | Telematics - Essential Plus |
| fleet/hos/clocks | Telematics - Essential Plus |
| fleet/hos/logs | Telematics - Essential Plus |
| fleet/reports/drivers/fuel-energy fleet/reports/vehicles/fuel-energy | Telematics - Premier |
| fleet/reports/ifta/jurisdiction | Telematics - Essential Plus |
| fleet/reports/ifta/vehicle | Telematics - Essential Plus |
| fleet/reports/vehicle/idling | Telematics - Premier |
| fleet/routes fleet/routes/audit-logs/feed | Telematics - Essential |
| fleet/safety-events fleet/safety-events/audit-logs/feed | Telematics - Essential or Safety - Essential You will have access even if your organization uses a Telematics license without a Safety license (i.e. you do not have CMs installed in your assets). However no video safety events will be generated. |
| fleet/settings/compliance | Telematics - Premier |
| fleet/settings/safety | Telematics - Essential or Safety - Essential |
| fleet/vehicles/stats fleet/vehicles/stats/feed fleet/vehicles/stats/history | Telematics - Essential or Safety - Essential |
| fleet/vehicles/tachograph-files/history | Telematics - Premier |
| fleet/vehicles/vehicleId/safety/harsh_event | Telematics - Essential or Safety - Essential You will have access even if your organization uses a Telematics license without a Safety license (i.e. you do not have CMs installed in your assets). However no video safety events will be generated. |
| fuel-purchase | Telematics - Essential |
| ifta-detail | Telematics - Essential Plus |
| v1/fleet/drivers/.driver_id/safety/score | Safety - Premier |
| v1/fleet/drivers/summary | Telematics - Premier |
| v1/fleet/maintenance/list | Telematics - Essential |
| v1/fleet/messages | Telematics - Essential |
| v1/fleet/vehicles/.vehicle_id/safety/score | Safety - Premier |
| webhooks | Platform - Premier |
Requirements for Using Specific API Parameters
These categories of parameters require a specific license to access. The table lists the minimum required licenses needed to use the parameters.
| Category | Endpoint | Minimum Required Plan |
|---|---|---|
| EV Diagnostics | fleet/vehicles/stats/feed | Telematics - Premier EV Add-On |
| Immobilizer State Readings | fleet/vehicles/stats/feed | Immobilizer Add-On |
| Spreader Diagnostics | fleet/vehicles/stats | Telematics - Premier Snow Add-On |
| Vehicle Diagnostics and Fault Codes | fleet/vehicles/stats | Telematics - Essential |
| External IDs | Various | Platform - Premier |
Required Licenses for Webhooks
At a minimum, you must have a Platform - Premier plan to use webhooks. While some webhooks are available with the Platform - Premier plan, some specific webhooks also have additional plan requirements. Refer to the following table for the list of webhooks that require additional plans.
| Webhook | Minimum Required Plan |
|---|---|
| Document Submitted | Telematics - Essential |
| DVIR Submitted | Telematics - Essential |
| Engine Fault Off | Telematics - Essential |
| Engine Fault On | Telematics - Essential |
| Geofence Entry | Telematics - Essential |
| Geofence Exit | Telematics - Essential |
| Route Stop Arrival | Telematics - Essential |
| Route Stop Departure | Telematics - Essential |
| Vehicle Created | Telematics - Essential |
| Vehicle Updated | Telematics - Essential |
Updated 1 day ago