All data sources

Samsara

Your key

Samsara fleet management and IoT connector for vehicles, equipment, drivers, GPS tracking, telematics, HOS compliance, safety events, and geofences.

Needs your own Samsara key. Included on Free.

What you can ask

  • “What does Samsara have for the area or asset I'm working on?”
  • “Pull the most recent Samsara records and put them in a table.”
  • “What does Samsara cover, and how fresh is the data?”

About this source

Samsara fleet/IoT — vehicles, equipment, drivers, GPS, telematics, HOS, safety, geofences, DVIRs. AUTH: Bearer token. Cursor-based pagination via pagination.endCursor → 'after' param. RATE: 150 req/s/token, 200 req/s/org. HTTP 429 with Retry-After. PATTERNS: snapshot (current), feed (cursor polling), history (time-range). STAT TYPES (max 3): gps, engineStates, engineRpm, fuelPercents, obdOdometerMeters, batteryMilliVolts, faultCodes, etc.

Connector ID samsara

Provenance

PublisherSamsara

Freshness & coverage

FreshnessFreshness not declared
GeographicNot declared
TemporalNot declared
AuthenticationCredentials required (Bearer token)

› Methods (385)

Technical detail for developers: parameters, pagination, units, and freshness per method.

  • listAddresses

    read

    List all addresses

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createAddress

    write

    Create an address

    Required paramsbody
    Paginationnone
  • getAddress

    read

    Retrieve an address

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateAddress

    write

    Update an address

    Required paramsidbody
    Paginationnone
  • deleteAddress

    write

    Delete an address

    Required paramsid
    Paginationnone
  • getVoiceSessions

    read

    [beta] Get voice agent session details

    Required paramsids
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVoiceSessionsStream

    read

    Stream voice sessions with Agent Studio agent IDs; this catalog has no agent-ID search.

    Required paramsstartTimeagentIds
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getConfigurations

    read

    Get Alert Configurations.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postConfigurations

    write

    Create alert configurations.

    Required paramsbody
    Paginationnone
  • patchConfigurations

    write

    Update alert configurations.

    Required paramsbody
    Paginationnone
  • deleteConfigurations

    write

    Delete alert configurations.

    Required paramsid
    Paginationnone
  • getIncidents

    read

    Get Alert Incidents.

    Required paramsstartTimeconfigurationIds
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listAssets

    read

    List fleet assets: vehicles, trailers, equipment, and unpowered assets

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createAsset

    write

    Create a new asset.

    Required paramsbody
    Paginationnone
  • updateAsset

    write

    Update an existing asset.

    Required paramsidbody
    Paginationnone
  • deleteAsset

    write

    Delete an existing asset.

    Required paramsid
    Paginationnone
  • getDepreciationTransactions

    read

    [beta] Get depreciation transactions.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getAssetsInputs

    read

    [beta] List asset inputs data in an organization.

    Required paramsidstypestartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getLocationAndSpeed

    read

    List asset location and speed data in an organization.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getAttributesByEntityType

    read

    List all attributes by entity type

    Required paramsentityType
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createAttribute

    write

    Create an attribute

    Required paramsbody
    Paginationnone
  • getAttribute

    read

    Retrieve an attribute

    Required paramsidentityType
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateAttribute

    write

    Update an attribute

    Required paramsidbody
    Paginationnone
  • deleteAttribute

    write

    Deleting an attribute

    Required paramsidentityType
    Paginationnone
  • getAempEquipmentList

    read

    [beta] Get a list of AEMP equipment

    Required paramspageNumber
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriverEfficiency

    read

    [beta] List driver efficiency

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchEquipment

    write

    [beta] Update an equipment

    Required paramsidbody
    Paginationnone
  • getHosEldEvents

    read

    [beta] Get driver HOS ELD events

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateEngineImmobilizerState

    write

    [beta] Update engine immobilizer state of a vehicle.

    Required paramsidbody
    Paginationnone
  • getJobs

    read

    [beta] Fetches all jobs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createJob

    write

    [beta] Create a job

    Required paramsbody
    Paginationnone
  • patchJob

    write

    [beta] Patches a job

    Required paramsidbody
    Paginationnone
  • deleteJob

    write

    [beta] Deletes an existing job

    Required paramsid
    Paginationnone
  • listUploadedMedia

    read

    List uploaded media by time range.

    Required paramsvehicleIdsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getMediaRetrieval

    read

    Get details for a media retrieval request

    Required paramsretrievalId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postMediaRetrieval

    write

    Create a media retrieval request

    Required paramsbody
    Paginationnone
  • getDriverCoachAssignment

    read

    Get driver coach assignments.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • putDriverCoachAssignment

    write

    Put driver coach assignments.

    Required paramsdriverId
    Paginationnone
  • getCoachingSessions

    read

    Get coaching sessions.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listContacts

    read

    List all contacts

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createContact

    write

    Create a contact

    Required paramsbody
    Paginationnone
  • getContact

    read

    Retrieve a contact

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateContact

    write

    Update a contact

    Required paramsidbody
    Paginationnone
  • deleteContact

    write

    Delete a contact

    Required paramsid
    Paginationnone
  • getDefectTypes

    read

    Get DVIR defect types.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • streamDefects

    read

    Stream DVIR defects.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDefect

    read

    Get a single DVIR defect by ID.

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDetections

    read

    [beta] Returns a list of all detections in an organization.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDevices

    read

    [beta] List devices.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriverEfficiencyByDrivers

    read

    Get Driver efficiency data grouped by drivers.

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriverEfficiencyByVehicles

    read

    Get Driver efficiency data grouped by vehicles.

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriverTrailerAssignments

    read

    Get currently active driver-trailer assignments for driver.

    Required paramsdriverIds
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createDriverTrailerAssignment

    write

    Create a new driver-trailer assignment

    Required paramsbody
    Paginationnone
  • updateDriverTrailerAssignment

    write

    Update an existing driver-trailer assignment.

    Required paramsidbody
    Paginationnone
  • getDriversQrCodes

    read

    Get driver QR codes

    Required paramsdriverIds
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createDriverQrCode

    write

    Create new QR code for driver

    Required paramsbody
    Paginationnone
  • deleteDriverQrCode

    write

    Revoke driver's QR code

    Required paramsbody
    Paginationnone
  • getDvirs

    read

    Stream DVIRs

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDvir

    read

    Get a single DVIR by ID.

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listAssetSharingAgreements

    read

    [beta] List all Data Sharing Agreements

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createAssetSharingAgreement

    write

    [beta] Create a Data Sharing Agreement

    Required paramsbody
    Paginationnone
  • deleteAssetSharingAgreement

    write

    [beta] Delete a Data Sharing Agreement

    Required paramsid
    Paginationnone
  • acceptAssetSharingAgreement

    write

    [beta] Accept a Data Sharing Agreement

    Required paramsid
    Paginationnone
  • listSharedAssets

    read

    [beta] List shared assets for an agreement

    Required paramsdsaId
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createSharedAssetsBatch

    write

    [beta] Share assets

    Required paramsdsaIdbody
    Paginationnone
  • updateSharedAssetsBatch

    write

    [beta] Update asset sharings

    Required paramsbody
    Paginationnone
  • cancelSharedAssetsBatch

    write

    [beta] Cancel asset sharings

    Required paramsbody
    Paginationnone
  • cancelAssetSharingAgreement

    write

    [beta] Cancel a Data Sharing Agreement

    Required paramsid
    Paginationnone
  • rejectAssetSharingAgreement

    write

    [beta] Reject a Data Sharing Agreement

    Required paramsid
    Paginationnone
  • listAssetAssignments

    read

    [beta] List active asset assignments.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createAssetAssignment

    write

    [beta] Create an asset assignment.

    Required paramsbody
    Paginationnone
  • unassignAssetAssignment

    write

    [beta] Unassign an asset assignment.

    Required paramsbody
    Paginationnone
  • listAssociations

    read

    [beta] List asset associations.

    Required paramsperipheralIdsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listDeviceRecoveryMissingAssets

    read

    [beta] List missing device recovery assets.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • markAssetMissing

    write

    [beta] Mark an asset as missing.

    Required paramsidbody
    Paginationnone
  • recoverAsset

    write

    [beta] Mark an asset as recovered.

    Required paramsidbody
    Paginationnone
  • listCarbCtcVehicles

    read

    List CARB CTC enrolled vehicles

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listCarbCtcVehicleHistory

    read

    List CARB CTC vehicle collection history

    Required paramsvehicleIds
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listCarrierProposedAssignments

    read

    Retrieve assignments

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createCarrierProposedAssignment

    write

    Create an assignment

    Paginationnone
  • deleteCarrierProposedAssignment

    write

    Delete an assignment

    Required paramsid
    Paginationnone
  • getDvirDefects

    read

    [legacy] Get all defects

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateDvirDefect

    write

    Update a defect

    Required paramsid
    Paginationnone
  • getDocumentTypes

    read

    Fetch document types

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDocuments

    read

    Fetch all documents

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postDocument

    write

    Create document

    Required paramsbody
    Paginationnone
  • generateDocumentPdf

    write

    Create a document PDF

    Paginationnone
  • getDocumentPdf

    read

    Query a document PDF

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDocument

    read

    Fetch document

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • deleteDocument

    write

    Delete document

    Required paramsid
    Paginationnone
  • getDriverVehicleAssignments

    read

    Get all driver-vehicle assignments

    Required paramsfilterBy
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createDriverVehicleAssignment

    write

    Create a new driver-vehicle assignment

    Required paramsbody
    Paginationnone
  • updateDriverVehicleAssignment

    write

    Update API generated driver-vehicle assignments

    Required paramsbody
    Paginationnone
  • deleteDriverVehicleAssignments

    write

    Delete API generated driver-vehicle assignments

    Required paramsbody
    Paginationnone
  • listDrivers

    read

    List all drivers

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createDriver

    write

    Create a driver

    Required paramsbody
    Paginationnone
  • postDriverRemoteSignout

    write

    Sign out a driver

    Required paramsbody
    Paginationnone
  • getDriverTachographActivity

    read

    Get driver tachograph activity

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriverTachographFiles

    read

    Get tachograph driver files

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriversVehicleAssignments

    read

    [legacy] Get all vehicles assigned to a set of drivers

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • resolveAssignmentByDetails

    write

    [beta] Voice sign-in: resolve driver and create assignment

    Required paramsbody
    Paginationnone
  • postDriverWorkflowAssignment

    write

    [beta] Publish a driver app workflow to drivers

    Required paramsbody
    Paginationnone
  • listDriverWorkflows

    read

    [beta] List driver app workflows

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriver

    read

    Retrieve a driver

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateDriver

    write

    Update a driver

    Required paramsidbody
    Paginationnone
  • createDvir

    write

    Create a mechanic DVIR

    Paginationnone
  • getDvirHistory

    read

    [legacy] Get all DVIRs

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateDvir

    write

    Resolve a DVIR

    Required paramsid
    Paginationnone
  • listEquipment

    read

    List all equipment

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipmentLocations

    read

    Get most recent locations for all equipment

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipmentLocationsFeed

    read

    Follow feed of equipment locations

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipmentLocationsHistory

    read

    Get historical equipment locations

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipmentStats

    read

    Get most recent stats for all equipment

    Required paramstypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipmentStatsFeed

    read

    Follow a feed of equipment stats

    Required paramstypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipmentStatsHistory

    read

    Get historical equipment stats

    Required paramsstartTimeendTimetypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEquipment

    read

    Retrieve a unit of equipment

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • setEquipmentDigitalOutput

    write

    [beta] Set an equipment digital output state

    Required paramsidbody
    Paginationnone
  • getHosClocks

    read

    Get HOS clocks

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getHosDailyLogs

    read

    Get all driver HOS daily logs

    Required paramsstartDateendDate
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getHosLogs

    read

    Get HOS logs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getHosViolations

    read

    Get all driver HOS violations

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getFleetInstallerPhotoUploads

    read

    [beta] List fleet installer photo uploads.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postFleetInstallerPhotoUpload

    write

    [beta] Create a fleet installer photo upload.

    Required paramsbody
    Paginationnone
  • postFleetInstallerPhotoUploadComplete

    write

    [beta] Complete a fleet installer photo upload.

    Required paramsid
    Paginationnone
  • listVendorCategories

    read

    [beta] List all vendor categories.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listMaintenanceVendors

    read

    [beta] List all maintenance vendors.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getFuelEnergyDriverReports

    read

    Get fuel and energy efficiency driver reports.

    Required paramsstartDateendDate
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getIftaJurisdictionReports

    read

    Get IFTA jurisdiction reports.

    Required paramsyear
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getIftaVehicleReports

    read

    Get IFTA vehicle reports.

    Required paramsyear
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleIdlingReports

    read

    [legacy] Get vehicle idling reports.

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getFuelEnergyVehicleReports

    read

    Get fuel and energy efficiency vehicle reports.

    Required paramsstartDateendDate
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • fetchRoutes

    read

    Fetch all routes

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createRoute

    write

    Create a route

    Required paramsbody
    Paginationnone
  • getRoutesFeed

    read

    Get route updates

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • fetchRoute

    read

    Fetch a route

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchRoute

    write

    Update a route

    Required paramsidbody
    Paginationnone
  • deleteRoute

    write

    Delete a route.

    Required paramsid
    Paginationnone
  • getSafetyEvents

    read

    [legacy] List all safety events.

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getSafetyActivityEventFeed

    read

    [legacy] Fetches safety activity event feed

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getComplianceSettings

    read

    Get compliance settings

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchComplianceSettings

    write

    Update compliance settings

    Required paramsbody
    Paginationnone
  • getDriverAppSettings

    read

    Get driver app settings

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchDriverAppSettings

    write

    Update driver app settings

    Required paramsbody
    Paginationnone
  • getSafetySettings

    read

    Get safety settings

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listTachographLiveData

    read

    [beta] List tachograph live data

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postTachographFileUpload

    write

    [beta] Create a tachograph file upload.

    Required paramsbody
    Paginationnone
  • listTrailers

    read

    List all trailers

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createTrailer

    write

    Creates a new trailer asset

    Required paramsbody
    Paginationnone
  • getTrailerStatsSnapshot

    read

    Get trailer stats

    Required paramstypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTrailerStatsFeed

    read

    Get trailer stats feed

    Required paramstypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTrailerStatsHistory

    read

    Get trailer stats history

    Required paramsstartTimeendTimetypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTrailer

    read

    Retrieve a trailer

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateTrailer

    write

    Update a trailer

    Required paramsidbody
    Paginationnone
  • deleteTrailer

    write

    Delete a trailer

    Required paramsid
    Paginationnone
  • listVehicles

    read

    List all vehicles.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehiclesDriverAssignments

    read

    [legacy] Get all drivers assigned to a set of vehicles

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getEngineImmobilizerStates

    read

    [beta] Get engine immobilizer states

    Required paramsvehicleIdsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleLocations

    read

    Locations snapshot

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleLocationsFeed

    read

    Locations feed

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleLocationsHistory

    read

    Historical locations

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleStats

    read

    Stats snapshot

    Required paramstypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleStatsFeed

    read

    Get vehicle stats feed

    Required paramstypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleStatsHistory

    read

    Historical stats

    Required paramsstartTimeendTimetypes
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleTachographFiles

    read

    Get tachograph vehicle files

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicle

    read

    Retrieve a vehicle

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateVehicle

    write

    Update a vehicle

    Required paramsidbody
    Paginationnone
  • getFormSubmissions

    read

    Get a list of specified form submissions.

    Required paramsids
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postFormSubmission

    write

    Create a form submission.

    Required paramsbody
    Paginationnone
  • patchFormSubmission

    write

    Update a single form submission.

    Required paramsbody
    Paginationnone
  • getFormSubmissionsPdfExports

    read

    Return a PDF export that has already been generated for a form submission.

    Required paramspdfId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postFormSubmissionsPdfExports

    write

    Create a PDF export for an existing form submission.

    Required paramsid
    Paginationnone
  • getFormSubmissionsStream

    read

    Get a stream of filtered form submissions.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getFormTemplates

    read

    Get a list of form templates.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postFuelPurchase

    write

    Create a fuel purchase transaction.

    Required paramsbody
    Paginationnone
  • createFunction

    write

    [beta] Create a Function.

    Required paramsbody
    Paginationnone
  • getFunctionStorageFile

    read

    [beta] Get a Functions storage file.

    Required paramsname
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createFunctionStorageFile

    write

    [beta] Create a Functions storage file.

    Required paramsbody
    Paginationnone
  • updateFunctionStorageFile

    write

    [beta] Update a Functions storage file.

    Required paramsname
    Paginationnone
  • deleteFunctionStorageFile

    write

    [beta] Delete a Functions storage file.

    Required paramsname
    Paginationnone
  • listFunctionsStorageFiles

    read

    [beta] List Functions storage files.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getFunction

    read

    [beta] Get a Function.

    Required paramsname
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchFunction

    write

    [beta] Update a Function.

    Required paramsnamebody
    Paginationnone
  • deleteFunction

    write

    [beta] Delete a Function.

    Required paramsname
    Paginationnone
  • deployFunction

    write

    [beta] Deploy a Function.

    Required paramsname
    Paginationnone
  • getFunctionLogs

    read

    Get Function logs by name; obtain the name in Samsara because no name search is exposed.

    Required paramsstartTimeendTimename
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • startFunctionRun

    write

    [beta] Start a Function run.

    Required paramsnamebody
    Paginationnone
  • getFunctionRun

    read

    [beta] Get a Function run.

    Required paramsnamecorrelationId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getGateways

    read

    List all gateways

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postGateway

    write

    Activate a new gateway

    Required paramsbody
    Paginationnone
  • pairGateways

    write

    [beta] Pair gateways to devices

    Required paramsbody
    Paginationnone
  • deleteGateway

    write

    Deactivate a gateway

    Required paramsid
    Paginationnone
  • listIssues

    read

    [beta] List Ground Intelligence issues

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateGroundIntelligenceIssue

    write

    [beta] Update a Ground Intelligence issue

    Required paramsidbody
    Paginationnone
  • createWatchpoint

    write

    [beta] Create a watchpoint

    Required paramsbody
    Paginationnone
  • updateWatchpoint

    write

    [beta] Update a watchpoint

    Required paramsidbody
    Paginationnone
  • updateShippingDocs

    write

    Update the shippingDocs field of an existing assignment.

    Required paramshosDatedriverIDbody
    Paginationnone
  • listHubCapacities

    read

    listHubCapacities: use listHubs for hubId.

    Required paramshubId
    Paginationcursor (cursorField: after)

    Use an id from listHubs as hubId; an empty tenant has no hub to query.

  • listHubCustomProperties

    read

    listHubCustomProperties: use listHubs for hubId.

    Required paramshubId
    Paginationcursor (cursorField: after)

    Use an id from listHubs as hubId; an empty tenant has no hub to query.

  • updateHubLocation

    write

    Update a location

    Required paramsidbody
    Paginationnone
  • listHubLocations

    read

    listHubLocations: use listHubs for hubId.

    Required paramshubId
    Paginationcursor (cursorField: after)

    Use an id from listHubs as hubId; an empty tenant has no hub to query.

  • createHubLocations

    write

    Create locations in bulk

    Required paramsbody
    Paginationnone
  • createHubPlan

    write

    Create a new plan

    Required paramsbody
    Paginationnone
  • listPlanOrders

    read

    listPlanOrders: use listHubPlans for planId.

    Required paramsplanId
    Paginationcursor (cursorField: after)

    Use listHubs, then listHubPlans for planId; the tenant must contain a plan.

  • createPlanOrders

    write

    Create orders in bulk

    Required paramsbody
    Paginationnone
  • deletePlanOrders

    write

    [beta] Delete orders from a plan

    Required paramsplanId
    Paginationnone
  • listHubPlanRoutes

    read

    listHubPlanRoutes: use listHubPlans for planId.

    Required paramsplanId
    Paginationcursor (cursorField: after)

    Use listHubs, then listHubPlans for planId; the tenant must contain a plan.

  • listHubPlans

    read

    listHubPlans: use listHubs for hubId.

    Required paramshubId
    Paginationcursor (cursorField: after)

    Use an id from listHubs as hubId; an empty tenant has no hub to query.

  • listHubRouteTemplates

    read

    listHubRouteTemplates: use listHubs for hubId.

    Required paramshubId
    Paginationcursor (cursorField: after)

    Use an id from listHubs as hubId; an empty tenant has no hub to query.

  • createHubRouteTemplate

    write

    [beta] Create a route template for a specific hub

    Required paramsbody
    Paginationnone
  • updateHubRouteTemplate

    write

    [beta] Update a route template

    Required paramsidbody
    Paginationnone
  • deleteHubRouteTemplate

    write

    [beta] Delete a route template

    Required paramsid
    Paginationnone
  • listHubSkills

    read

    listHubSkills: use listHubs for hubId.

    Required paramshubId
    Paginationcursor (cursorField: after)

    Use an id from listHubs as hubId; an empty tenant has no hub to query.

  • listHubs

    read

    List all hubs for the organization

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getIdlingEvents

    read

    Get idling events.

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createIftaDetailJob

    write

    Create a job to generate csv files of IFTA mileage segments.

    Required paramsbody
    Paginationnone
  • getIftaDetailJob

    read

    Get information about an existing IFTA detail job.

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getIndustrialAssets

    read

    List industrial IoT assets used by Equipment monitoring

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createIndustrialAsset

    write

    Create an asset

    Paginationnone
  • patchIndustrialAsset

    write

    Update an asset

    Required paramsid
    Paginationnone
  • deleteIndustrialAsset

    write

    Delete an existing asset

    Required paramsid
    Paginationnone
  • patchAssetDataOutputs

    write

    Writes to data outputs on an asset

    Required paramsidbody
    Paginationnone
  • getDataInputs

    read

    List all data inputs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDataInputDataSnapshot

    read

    List most recent data points for data inputs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDataInputDataFeed

    read

    Follow a real-time feed of data points for data inputs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDataInputDataHistory

    read

    List historical data points for data inputs

    Required paramsstartTimeendTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getIssues

    read

    Get a list of specified issues.

    Required paramsids
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postIssue

    write

    Create a single issue.

    Required paramsbody
    Paginationnone
  • patchIssue

    write

    Update a single issue.

    Required paramsbody
    Paginationnone
  • getIssuesStream

    read

    Get a stream of filtered issues.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postInvoiceScan

    write

    Process an invoice scan.

    Required paramsbody
    Paginationnone
  • listParts

    read

    [beta] List parts

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createPart

    write

    [beta] Create a part

    Required paramsbody
    Paginationnone
  • updatePart

    write

    [beta] Update a part

    Required paramsidbody
    Paginationnone
  • deletePart

    write

    [beta] Delete a part

    Required paramsid
    Paginationnone
  • listPartInventory

    read

    [beta] List part inventory

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createPartInventoryLocation

    write

    [beta] Create a part inventory location

    Required paramsbody
    Paginationnone
  • updatePartInventoryLocation

    write

    [beta] Update a part inventory location

    Required paramsbody
    Paginationnone
  • createStockMovement

    write

    [beta] Create a stock movement

    Required paramsbody
    Paginationnone
  • listPartTransactions

    read

    [beta] List part transactions

    Required paramshappenedAtTimeStart
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • resolvePreventiveMaintenance

    write

    Resolve a preventive maintenance instance

    Required paramsbody
    Paginationnone
  • listPreventiveMaintenanceSchedules

    read

    List preventive maintenance schedules

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listUpcomingPreventiveMaintenance

    read

    List upcoming preventive maintenance

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateUpcomingPreventiveMaintenance

    write

    Update an upcoming preventive maintenance instance

    Required paramsbody
    Paginationnone
  • listPurchaseOrders

    read

    [beta] List purchase orders

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createPurchaseOrder

    write

    [beta] Create a purchase order

    Required paramsbody
    Paginationnone
  • updatePurchaseOrder

    write

    [beta] Update a purchase order

    Required paramsidbody
    Paginationnone
  • deletePurchaseOrder

    write

    [beta] Delete a purchase order

    Required paramsid
    Paginationnone
  • getServiceTasks

    read

    Gets service tasks.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listMaintenanceSites

    read

    [beta] List maintenance sites

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createMaintenanceSite

    write

    [beta] Create a maintenance site

    Required paramsbody
    Paginationnone
  • updateMaintenanceSite

    write

    [beta] Update a maintenance site

    Required paramsidbody
    Paginationnone
  • listTimeEntries

    read

    [beta] List time entries

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listWarranties

    read

    [beta] List warranties

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createWarranty

    write

    [beta] Create a warranty

    Required paramsbody
    Paginationnone
  • updateWarranty

    write

    [beta] Update a warranty

    Required paramsidbody
    Paginationnone
  • deleteWarranty

    write

    [beta] Delete a warranty

    Required paramsid
    Paginationnone
  • listWarrantyAssetAssignments

    read

    [beta] List warranty asset assignments

    Required paramswarrantyId
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • replaceWarrantyAssetAssignments

    write

    [beta] Replace warranty asset assignments

    Required paramsbody
    Paginationnone
  • listWarrantyClaims

    read

    [beta] List warranty claims

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createWarrantyClaim

    write

    [beta] Create a warranty claim

    Required paramsbody
    Paginationnone
  • updateWarrantyClaim

    write

    [beta] Update a warranty claim

    Required paramsidbody
    Paginationnone
  • deleteWarrantyClaim

    write

    [beta] Delete a warranty claim

    Required paramsid
    Paginationnone
  • getWorkOrderTemplates

    read

    [beta] Gets work order templates.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getWorkOrders

    read

    Gets work orders.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postWorkOrders

    write

    Creates a work order.

    Required paramsbody
    Paginationnone
  • patchWorkOrders

    write

    Updates a work order.

    Required paramsbody
    Paginationnone
  • deleteWorkOrders

    write

    Deletes a work order.

    Required paramsid
    Paginationnone
  • streamWorkOrders

    read

    Stream work orders.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getOrganizationInfo

    read

    Get information about your organization

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getPlaces

    read

    [beta] List or batch-get places

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postPlace

    write

    [beta] Create a place

    Required paramsbody
    Paginationnone
  • patchPlace

    write

    [beta] Update a place

    Required paramsbody
    Paginationnone
  • deletePlace

    write

    [beta] Delete a place

    Required paramsplaceId
    Paginationnone
  • getPlaceDeletions

    read

    [beta] Poll place deletions

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getPlaceGeocode

    read

    [beta] Forward geocode an address

    Required paramsaddress
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getPlaceGeofence

    read

    [beta] Look up geofence suggestions

    Required paramslatitudelongitude
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listPreferredStations

    read

    [beta] List preferred fuel stations.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postPreferredStation

    write

    [beta] Create a preferred fuel station.

    Required paramsbody
    Paginationnone
  • patchPreferredStation

    write

    [beta] Update a preferred fuel station.

    Required paramsidbody
    Paginationnone
  • deletePreferredStation

    write

    [beta] Delete a preferred fuel station.

    Required paramsid
    Paginationnone
  • getPreferredStation

    read

    [beta] Get a preferred fuel station.

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getOrders

    read

    [preview] Get orders

    Required paramsorderIds
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • deleteOrder

    write

    [preview] Delete an order

    Required paramsorderId
    Paginationnone
  • postOrdersBatch

    write

    [preview] Upsert orders

    Required paramsbody
    Paginationnone
  • getOrderDeletions

    read

    [preview] Get order deletions

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getOrdersStream

    read

    [preview] Stream orders

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • lockVehicle

    write

    [preview] Lock a vehicle.

    Required paramsid
    Paginationnone
  • unlockVehicle

    write

    [preview] Unlock a vehicle.

    Required paramsid
    Paginationnone
  • getQualificationRecords

    read

    [beta] Get a list of specified qualification records.

    Required paramsids
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postQualificationRecord

    write

    [beta] Create a qualification record.

    Required paramsbody
    Paginationnone
  • patchQualificationRecord

    write

    [beta] Update a qualification record.

    Required paramsbody
    Paginationnone
  • deleteQualificationRecord

    write

    [beta] Delete a qualification record.

    Required paramsbody
    Paginationnone
  • archiveQualificationRecord

    write

    [beta] Archive a qualification record.

    Required paramsbody
    Paginationnone
  • getQualificationRecordsStream

    read

    [beta] Get a stream of filtered qualification records.

    Required paramsentityTypestartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • unarchiveQualificationRecord

    write

    [beta] Unarchive a qualification record.

    Required paramsbody
    Paginationnone
  • getQualificationTypes

    read

    [beta] Get a list of qualification types.

    Required paramsentityType
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postReadings

    write

    [beta] Ingest Readings

    Required paramsbody
    Paginationnone
  • listReadingsDefinitions

    read

    Get Readings Definitions

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getReadingsHistory

    read

    Get Readings History and Feed

    Required paramsreadingIdentityType
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getReadingsSnapshot

    read

    Get Readings Snapshot

    Required paramsreadingIdsentityType
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getReportConfigs

    read

    [beta] Get custom report configs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDatasets

    read

    [beta] Get custom report datasets

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getReportRuns

    read

    [beta] Get custom report runs

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createReportRun

    write

    [beta] Create a custom report run

    Required paramsbody
    Paginationnone
  • getReportRunData

    read

    [beta] Get custom report run data

    Required paramsid
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listRidershipPassengers

    read

    [beta] List ridership passengers.

    Required paramstagId
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createRidershipPassenger

    write

    [beta] Create a ridership passenger.

    Required paramsbody
    Paginationnone
  • updateRidershipPassenger

    write

    [beta] Update a ridership passenger.

    Required paramsidbody
    Paginationnone
  • deleteRidershipPassenger

    write

    [beta] Delete a ridership passenger.

    Required paramsid
    Paginationnone
  • getRidershipPassenger

    read

    [beta] Get a ridership passenger.

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listRidershipRouteSetups

    read

    [beta] List ridership route setups.

    Required paramsaccountId
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createRidershipRouteSetup

    write

    [beta] Create a ridership route setup.

    Required paramsbody
    Paginationnone
  • updateRidershipRouteSetup

    write

    [beta] Update a ridership route setup.

    Required paramsrouteIdbody
    Paginationnone
  • deleteRidershipRouteSetup

    write

    [beta] Delete a ridership route setup.

    Required paramsrouteId
    Paginationnone
  • getRidershipRouteSetup

    read

    [beta] Get a ridership route setup.

    Required paramsrouteId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getRouteEventsStream

    read

    Get route events stream

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getSafetyEventsV2

    read

    Get Safety Events

    Required paramssafetyEventIds
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchSafetyEventsV2Batch

    write

    [beta] Update Safety Events

    Required paramsbody
    Paginationnone
  • getSafetyEventsV2Stream

    read

    Get Safety Events Stream

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getDriverSafetyScores

    read

    Get driver scores

    Required paramsendTimestartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTagGroupSafetyScores

    read

    Get tags combined score

    Required paramsendTimestartTimescoreType
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTagSafetyScores

    read

    Get tag scores

    Required paramsendTimestartTimescoreType
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVehicleSafetyScores

    read

    Get vehicle scores

    Required paramsendTimestartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getSpeedingIntervals

    read

    Get Speeding Intervals

    Required paramsassetIdsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listTags

    read

    List all tags

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createTag

    write

    Create a tag

    Required paramsbody
    Paginationnone
  • getTag

    read

    Retrieve a tag

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • replaceTag

    write

    Update a tag

    Required paramsidbody
    Paginationnone
  • patchTag

    write

    Update a tag

    Required paramsidbody
    Paginationnone
  • deleteTag

    write

    Delete a tag

    Required paramsid
    Paginationnone
  • postTrainingAssignments

    write

    Create training assignments.

    Required paramscourseIddueAtTimelearnerIds
    Paginationnone
  • patchTrainingAssignments

    write

    Update training assignments.

    Required paramsidsdueAtTime
    Paginationnone
  • deleteTrainingAssignments

    write

    Delete training assignments.

    Required paramsids
    Paginationnone
  • getTrainingAssignmentsStream

    read

    Get a stream of filtered training assignments.

    Required paramsstartTime
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTrainingCourses

    read

    Get a list of filtered training courses.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getTrips

    read

    Get Trips Stream

    Required paramsstartTimeids
    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listUserRoles

    read

    List all user roles

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listUsers

    read

    List all users

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • createUser

    write

    Create a user

    Required paramsbody
    Paginationnone
  • getUser

    read

    Retrieve a user

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • updateUser

    write

    Update a user

    Required paramsidbody
    Paginationnone
  • deleteUser

    write

    Delete a user

    Required paramsid
    Paginationnone
  • v1getAllAssets

    read

    [Legacy] List all assets

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getAllAssetCurrentLocations

    read

    List current location for all assets

    Paginationcursor (cursorField: startingAfter)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getAssetsReefers

    read

    List stats for all reefers

    Required paramsstartMsendMs
    Paginationcursor (cursorField: startingAfter)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getAssetLocation

    read

    List historical locations for a given asset

    Required paramsassetId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getAssetReefer

    read

    List stats for a given reefer

    Required paramsstartMsendMsassetId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getAssetLocation

    read

    List historical locations for a given asset

    Required paramsasset_idstartMsendMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getAssetReefer

    read

    List stats for a given reefer

    Required paramsasset_idstartMsendMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1deleteDispatchRouteById

    write

    Delete a route

    Required paramsroute_id_or_external_id
    Paginationnone
  • v1getDriverSafetyScore

    read

    Fetch driver safety score

    Required paramsdriverIdstartMsendMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • setCurrentDutyStatus

    write

    Set a duty status for a specific driver

    Required paramsdriver_id
    Paginationnone
  • v1getFleetHosAuthenticationLogs

    read

    Get HOS signin and signout

    Required paramsdriverIdstartMsendMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getFleetLocations

    read

    /fleet/locations

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getFleetMaintenanceList

    read

    Get vehicles with engine faults or check lights

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getMessages

    read

    Get all messages.

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1createMessages

    write

    Send a message to a list of driver ids.

    Required paramsbody
    Paginationnone
  • v1getAllTrailerAssignments

    read

    List trailer assignments for all trailers

    Paginationcursor (cursorField: startingAfter)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getFleetTrailerAssignments

    read

    List trailer assignments for a given trailer

    Required paramstrailerId
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getFleetTrips

    read

    Get vehicle trips

    Required paramsvehicleIdstartMsendMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getVehicleHarshEvent

    read

    [legacy] Fetch harsh events

    Required paramsvehicleIdtimestamp
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getVehicleSafetyScore

    read

    Fetch vehicle safety scores

    Required paramsvehicleIdstartMsendMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getCameras

    read

    Fetch industrial cameras

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getVisionProgramsByCamera

    read

    Fetch industrial camera programs

    Required paramscamera_id
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getVisionLatestRunCamera

    read

    Fetch the latest run for a camera or program

    Required paramscamera_id
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getVisionRuns

    read

    Fetch industrial vision runs

    Required paramsdurationMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • getVisionRunsByCamera

    read

    Fetch runs by camera

    Required paramscamera_iddurationMs
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getVisionRunsByCameraAndProgram

    read

    Fetch runs by camera and program

    Required paramscamera_idprogram_idstarted_at_ms
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getMachinesHistory

    read

    Get machine history

    Required paramsbody
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getMachines

    read

    Get machines

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getSensorsCargo

    read

    Get cargo status

    Required paramsbody
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getSensorsDoor

    read

    Get door status

    Required paramsbody
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getSensorsHistory

    read

    Get sensor history

    Required paramsbody
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getSensorsHumidity

    read

    Get humidity

    Required paramsbody
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getSensors

    read

    Get all sensors

    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • v1getSensorsTemperature

    read

    Get temperature

    Required paramsbody
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • listWebhooks

    read

    List all webhooks belonging to a specific org.

    Paginationcursor (cursorField: after)

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • postWebhooks

    write

    Create a webhook

    Required paramsbody
    Paginationnone
  • getWebhook

    read

    Retrieve a webhook with given ID

    Required paramsid
    Paginationnone

    Tenant may be empty; zero rows is complete only after pagination is exhausted.

  • patchWebhook

    write

    Update a specific webhook's information.

    Required paramsidbody
    Paginationnone
  • deleteWebhook

    write

    Delete a webhook with the given ID

    Required paramsid
    Paginationnone