Jump to Content
Guides
Example Scripts
REST API
Changelog
Community
Webhooks
Streaming
Developer Newsletter
Become a Technology Partner
SUPPORT
FEEDBACK
REST API
SUPPORT
FEEDBACK
Guides
Example Scripts
REST API
Changelog
Community
Webhooks
Streaming
Developer Newsletter
Become a Technology Partner
Work Orders
All
Pages
Start typing to search…
JUMP TO
Samsara API
Overview
Work Orders
Legacy
Core
Addresses
Create an address
post
Delete an address
del
List all addresses
get
Retrieve an address
get
Update an address
patch
Alerts
Create alert configurations.
post
Delete alert configurations.
del
Get Alert Configurations.
get
Get Alert Incidents.
get
Update alert configurations.
patch
Attributes
Create an attribute
post
Deleting an attribute
del
List all attributes by entity type
get
Retrieve an attribute
get
Update an attribute
patch
Contacts
Create a contact
post
Delete a contact
del
List all contacts
get
Retrieve a contact
get
Update a contact
patch
Gateways
Activate a new gateway
post
Deactivate a gateway
del
List all gateways
get
Live Sharing Links
Create Live Sharing Link
post
Delete non-expired Live Sharing Link
del
Get Live Sharing Links
get
Update non-expired Live Sharing Link
patch
Organization Info
Get information about your organization
get
Settings
Get compliance settings
get
Get driver app settings
get
Get safety settings
get
Update compliance settings
patch
Update driver app settings
patch
Tags
Create a tag
post
Delete a tag
del
List all tags
get
Retrieve a tag
get
Update a tag
put
Update a tag
patch
Trips
Get vehicle trips
get
Users
Create a user
post
Delete a user
del
List all user roles
get
List all users
get
Retrieve a user
get
Update a user
patch
Webhooks
Create a webhook
post
Delete a webhook with the given ID
del
List all webhooks belonging to a specific org.
get
Retrieve a webhook with given ID
get
Update a specific webhook's information.
patch
Assets: Vehicles, Trailers, Equipment
Assets
Create a new asset.
post
Delete an existing asset.
del
List all assets.
get
List current location for all assets
get
List historical locations for a given asset
get
List stats for a given reefer
get
List stats for all reefers
get
Update an existing asset.
patch
[Legacy] List all assets
get
[beta] List asset inputs data in an organization.
get
Equipment
Follow a feed of equipment stats
get
Follow feed of equipment locations
get
Get historical equipment locations
get
Get historical equipment stats
get
Get most recent locations for all equipment
get
Get most recent stats for all equipment
get
List all equipment
get
Retrieve a unit of equipment
get
Location and Speed
List asset location and speed data in an organization.
get
Sensors
Get all sensors
post
Get cargo status
post
Get door status
post
Get humidity
post
Get sensor history
post
Get temperature
post
Trailer Assignments
List trailer assignments for a given trailer
get
List trailer assignments for all trailers
get
Trailers
Creates a new trailer asset
post
Delete a trailer
del
List all trailers
get
Retrieve a trailer
get
Update a trailer
patch
Vehicle Locations
Historical locations
get
Locations feed
get
Locations snapshot
get
Vehicle Stats
Historical stats
get
Stats feed
get
Stats snapshot
get
Vehicles
List all vehicles.
get
Retrieve a vehicle
get
Update a vehicle
patch
Drivers
Driver QR Codes
Create new QR code for driver
post
Get driver QR codes
get
Revoke driver's QR code
del
Driver-Vehicle Assignments
Create a new driver-vehicle assignment
post
Delete API generated driver-vehicle assignments
del
Get all driver-vehicle assignments
get
Update API generated driver-vehicle assignments
patch
Drivers
Create a driver
post
List all drivers
get
Retrieve a driver
get
Sign out a driver
post
Update a driver
patch
Messages
Get all messages.
get
Send a message to a list of driver ids.
post
Compliance
Hours of Service
Get HOS clocks
get
Get HOS logs
get
Get HOS signin and signout
get
Get all driver HOS daily logs
get
Get all driver HOS violations
get
Set a duty status for a specific driver
post
[beta] Get driver HOS ELD events
get
Tachograph (EU Only)
Get driver tachograph activity
get
Get tachograph driver files
get
Get tachograph vehicle files
get
Fuel and efficiency
Fuel and Energy
Create a fuel purchase transaction.
post
Get Driver efficiency data grouped by drivers.
get
Get Driver efficiency data grouped by vehicles.
get
Get fuel and energy efficiency driver reports.
get
Get fuel and energy efficiency vehicle reports.
get
IFTA
Create a job to generate csv files of IFTA mileage segments.
post
Get IFTA jurisdiction reports.
get
Get IFTA vehicle reports.
get
Get information about an existing IFTA detail job.
get
Idling
Get idling events.
get
[legacy] Get vehicle idling reports.
get
Workflows
Carrier Proposed Assignments
Create an assignment
post
Delete an assignment
del
Retrieve assignments
get
Documents
Create a document PDF
post
Create document
post
Delete document
del
Fetch all documents
get
Fetch document
get
Fetch document types
get
Query a document PDF
get
Forms
Create a PDF export for an existing form submission.
post
Create a form submission.
post
Get a list of form templates.
get
Get a list of specified form submissions.
get
Get a stream of filtered form submissions.
get
Return a PDF export that has already been generated for a form submission.
get
Update a single form submission.
patch
Issues
Get a list of specified issues.
get
Get a stream of filtered issues.
get
Update a single issue.
patch
ROUTING
Hubs
Create locations in bulk
post
List all hubs for the organization
get
List capacities for a specific hub
get
List locations for a specific hub
get
List skills for a specific hub
get
Update a location
patch
Plans
Create a new plan
post
List plans for a specific hub
get
List routes for a specific plan
get
Route Events
Get route events stream
get
Routes
Create a route
post
Delete a route.
del
Fetch a route
get
Fetch all routes
get
Get route updates
get
Update a route
patch
Maintenance
Maintenance
Create a mechanic DVIR
post
Get DVIR defect types.
get
Get a single DVIR by ID.
get
Get a single DVIR defect by ID.
get
Get vehicles with engine faults or check lights
get
Resolve a DVIR
patch
Stream DVIR defects.
get
Stream DVIRs
get
Update a defect
patch
Work Orders
Creates a work order.
post
Deletes a work order.
del
Gets service tasks.
get
Gets work orders.
get
Stream work orders.
get
Updates a work order.
patch
Safety
Coaching
Get coaching sessions.
get
Get driver coach assignments.
get
Put driver coach assignments.
put
Media
Create a media retrieval request
post
Get details for a media retrieval request
get
List uploaded media by time range.
get
Safety
Fetch driver safety score
get
Fetch harsh events
get
Fetch vehicle safety scores
get
Fetches safety activity event feed
get
List all safety events.
get
Speeding Intervals
Get Speeding Intervals
get
Future
Beta APIs
[beta] Archive a qualification record.
post
[beta] Create a new driver-trailer assignment
post
[beta] Create a qualification record.
post
[beta] Create orders in bulk
post
[beta] Create training assignments.
post
[beta] Delete a qualification record.
del
[beta] Delete training assignments.
del
[beta] Get Readings Definitions
get
[beta] Get Readings History and Feed
get
[beta] Get Readings Snapshot
get
[beta] Get Safety Events
get
[beta] Get Safety Events Stream
get
[beta] Get a list of AEMP equipment
get
[beta] Get a list of filtered training courses.
get
[beta] Get a list of qualification types.
get
[beta] Get a list of specified qualification records.
get
[beta] Get a stream of filtered qualification records.
get
[beta] Get a stream of filtered training assignments.
get
[beta] Get currently active driver-trailer assignments for driver.
get
[beta] Get driver scores
get
[beta] Get driver scores trip breakdown
get
[beta] Get engine immobilizer states
get
[beta] Get tag scores
get
[beta] Get tags combined score
get
[beta] Get trailer stats
get
[beta] Get trailer stats feed
get
[beta] Get trailer stats history
get
[beta] Get trips
get
[beta] Get vehicle scores
get
[beta] Get vehicle scores trip breakdown
get
[beta] Ingest Readings
post
[beta] List devices.
get
[beta] Returns a list of all detections in an organization.
get
[beta] Start a Function run.
post
[beta] Unarchive a qualification record.
post
[beta] Update a qualification record.
patch
[beta] Update an equipment
patch
[beta] Update an existing driver-trailer assignment.
patch
[beta] Update engine immobilizer state of a vehicle.
patch
[beta] Update the shippingDocs field of an existing assignment.
patch
[beta] Update training assignments.
patch
Preview APIs
[preview] Create auth token for a driver
post
[preview] Lock a vehicle.
put
[preview] Unlock a vehicle.
del
Legacy
Industrial
List all assets
get
Create an asset
post
Delete an existing asset
del
Update an asset
patch
Writes to data outputs on an asset
patch
List all data inputs
get
List most recent data points for data inputs
get
Follow a real-time feed of data points for data inputs
get
List historical data points for data inputs
get
Fetch industrial cameras
get
Fetch industrial camera programs
get
Fetch the latest run for a camera or program
get
Fetch runs
get
[beta] Deletes an existing job
del
Fetch runs by camera
get
[beta] Fetches all jobs
get
Fetch runs by camera and program
get
[beta] Patches a job
patch
Get machine history
post
[beta] Create a job
post
Get machines
post
Legacy APIs
[beta] List driver efficiency
get
[legacy] Get all defects
get
[legacy] Get all vehicles assigned to a set of drivers
get
[legacy] Get all DVIRs
get
[legacy] Get all drivers assigned to a set of vehicles
get
Delete a route
del
Work Orders
