Jump to Content
API Reference
Log In
Log In
API Reference
Search
JUMP TO
Overview
Introduction
Endpoints
Authentication
Authorization (OAuth 2.0)
OAuth Scopes
Time Zone
System of Units
API User
HTTP Version
Request Methods
Request Content Type
Response Codes
Response Formats
Pagination
Changelog
Sample Workflows
Freight Visibility Workflow
Step 1. Get a list of the carriers who have consented to expose their Freight Visibility to you.
get
Step 2. Get locations of all vehicles of a company and their proximity to your location of interest.
get
Step 3. Start tracking the vehicle of your choice by subscribing to its location.
post
Step 4. Modify the subscription to change tracking time.
put
Step 5. Get location updates for all your subscribed vehicle locations.
get
Step 6. Get past locations for a specific vehicle.
get
Step 7. Get locations of all assets of a company and their proximity to your location of interest.
get
Step 8. Get aggregated location updates for all your subscribed asset locations.
get
TMS Integration Workflow
Step 1. Begin setup: sync your users.
put
Step 2. Sync your vehicles.
put
Step 3. Sync your assets.
put
Step 4. Complete setup: sync your geofences.
post
Step 5. Track vehicles and assets.
get
Step 6. Get drivers’ available time.
get
Step 7. Communicate with your drivers.
post
Step 8. Get the forms you can use for a dispatch.
get
Step 9. Get the list of stops for your dispatch.
get
Step 10. Create a dispatch!
post
Step 11. Update the planned dispatch.
put
Step 12. Get updates.
get
Step 13. Get vehicle utilization reports.
get
Step 14. Get and update inspection reports.
get
Users
Overview
/users
get
/users/:id
get
/users
post
/users
put
/users/lookup
get
/users/lookup_by_external_id
get
Vehicles
Overview
/vehicles
get
/vehicles/:id
get
/vehicles
post
/vehicles/:id
put
/vehicles/lookup
get
/vehicles/lookup_by_external_id
get
ELD Devices
Overview
/eld_devices
get
Groups
Overview
/groups
get
/groups/:id
get
/groups
post
/groups/:id
put
/groups/:id
delete
/groups/:id/users
get
/groups/:id/users
post
/groups/:id/users
delete
/groups/:id/vehicles
get
/groups/:id/vehicles
post
/groups/:id/vehicles
delete
HOS Logs
Overview
/available_time
get
/hours_of_service
get
/hos_violations
get
/logs
get
Locations
Overview
/vehicle_locations
get
/vehicle_locations (v2)
get
/vehicle_locations/:id
get
/vehicle_locations/:id (v2)
get
/vehicle_locations/:id (v3)
get
/driver_locations
get
/asset_locations
get
/asset_locations/:id
get
Messages
Overview
/messages
get
/messages
post
/messages
put
/messages (v2)
get
/messages (v2)
post
Inspection Reports
Overview
/inspection_reports
get
/inspection_reports/:id
put
/inspection_reports/lookup_by_external_id
get
IFTA Reports
Overview
/ifta/trips
get
/ifta/summary
get
Fault Codes
Overview
/fault_codes
get
Driver Performance Events
Overview
/driver_performance_events
get
Driving Periods
Overview
/driving_periods
get
Scorecard Summary
Overview
/scorecard_summary
get
Company Webhooks
Overview
/company_webhooks
get
/company_webhooks/:id
get
/company_webhooks
post
/company_webhooks/:id
put
/company_webhook_requests
get
/company_webhook_requests/retry
post
Fuel Purchases
Overview
/fuel_purchases
get
/fuel_purchases/:id
get
/fuel_purchases
post
/fuel_purchase_imports
post
/fuel_purchases/:id
put
/fuel_purchases/:id
delete
Utilization
Overview
/driver_utilization
get
/driver_utilization
get
/vehicle_utilization
get
/idle_events
get
Forms
Overview
/forms
get
Form Entries
Overview
/form_entries
get
Dispatch Locations
Overview
/dispatch_locations
get
/dispatch_locations
post
/dispatch_locations
put
/dispatch_locations
delete
Dispatches
Overview
/dispatches
get
/dispatches
post
/dispatches
put
Dispatches (v2)
Overview
/dispatches
get
/dispatches
post
/dispatches
put
Documents
Overview
/documents
get
/documents/:id
get
/documents
post
/documents/:id
put
/documents/:id
delete
/documents/forms (v2)
get
/documents/forms/:id (v2)
get
/documents (v2)
get
/documents/:id (v2)
get
/documents (v2)
post
/documents/:id (v2)
put
Geofences
Overview
/geofences
get
/geofences/:id
get
/geofences
post
/geofences/:id
put
/geofences/:id
delete
/geofences/events
get
/geofences/asset_events
get
Freight Visibility
Overview
freight_visibility/vehicle_locations
get
freight_visibility/subscribe
post
freight_visibility/subscribe
put
freight_visibility/subscribe
delete
freight_visibility/companies
get
freight_visibility/company_associated
get
freight_visibility/vehicle_association
get
freight_visibility/vehicle_association (v2)
get
freight_visibility/vehicle_subscriptions
get
freight_visibility/vehicle_locations/details
get
freight_visibility/asset_association
get
freight_visibility/asset_locations
get
Assets
Overview
/assets
get
/assets/lookup_by_external_id
get
/assets
post
/assets/:id
put
Freight MarketPlace API
FreightMarketplaceAPI
List carriers
get
Create a carrier
post
Update a carrier
put
Update a carrier
patch
View a carrier
get
Delete a carrier
delete
List loads
get
Create a load
post
View multiple loads
post
Create loads in bulk
post
Update loads in bulk
put
Update loads in bulk
patch
Update a load
put
Update a load
patch
View a load
get
Delete a load
delete
Get preferences
get
Offers Webhook Flow
<