Following is a list of all the OAuth scopes currently supported by our API.
All GET
endpoints require only read access of the respective scope. However, for any method other than GET
, write access is required.
By default, you should always enable the /companies endpoint in scopes. This endpoint gives the developer the information about the company e.g Name, DOT ID, Address etc. Without the /companies scope, the developer will not be able to distinguish which access token belongs to which company so its imperative to enable this scope for every application.
Scope | Access Type | Endpoints Allowed |
---|---|---|
Drivers and Fleet Managers |
| GET /:version/users |
Vehicles |
| GET /:version/vehicles |
Messages |
| GET /:version/messages |
Fuel Purchases |
| GET /:version/fuel_purchases |
Groups |
| GET /:version/groups |
ELDs |
| GET /:version/eld_devices |
Inspection Reports |
| GET /:version/inspection_reports |
Fault Codes |
| GET /:version/fault_codes |
Scorecards |
| GET /:version/driver_performance_events |
Drivers with Available Time |
| GET /:version/available_time |
Drivers with Hours of Service |
| GET /:version/hours_of_service |
HOS Violations |
| GET /:version/hos_violations |
HOS Logs |
| GET /:version/logs |
Vehicles with Current Location and Current Driver |
| GET /:version/vehicle_locations |
Vehicle Location History |
| GET /:version/vehicle_locations/:vehicle_id |
Drivers with Current Location and Current Vehicle |
| GET /:version/driver_locations |
IFTA Trip Reports |
| GET /:version/ifta/trips |
Vehicles' Mileage Summary |
| GET /:version/ifta/summary |
Utilization Summary by Driver |
| GET /:version/driver_utilization |
Utilization Summary by Vehicle |
| GET /:version/vehicle_utilization |
Utilization Records |
| GET /:version/idle_events |
Documents |
| GET /:version/documents |
Company Details |
| GET /:version/companies |
Dispatch Forms |
| GET /:version/forms |
Dispatch Form Entries |
| GET /:version/form_entries |
Dispatch Locations |
| GET /:version/dispatch_locations |
Dispatches |
| GET /:version/dispatches |
Geofences |
| GET /:version/geofences |
Geofence Events |
| GET /:version/geofences/events |
Documents |
| GET /:version/documents |
Assets |
| GET /:version/assets |
Freight Visibility |
| GET /:version/freight_visibility/vehicle_locations |
Asset with Asset Gateway Location History |
| GET /:version/asset_locations |