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 | - Read - Write | GET /:version/users GET /:version/users/:id PUT /:version/users/:id POST /:version/users |
| Vehicles | - Read - Write | GET /:version/vehicles GET /:version/vehicles/:id POST /:version/vehicles PUT /:version/vehicles/:id |
| Messages | - Read - Write | GET /:version/messages POST /:version/messages PUT /:version/messages |
| Fuel Purchases | - Read - Write | GET /:version/fuel_purchases GET /:version/fuel_purchases/:id POST /:version/fuel_purchases PUT /:version/fuel_purchases/:id DELETE /:version/fuel_purchases/:id |
| Groups | - Read - Write | GET /:version/groups POST /:version/groups GET /:version/groups/:id DELETE /:version/groups/:id PUT /:version/groups/:id GET /:version/groups/:id/users GET /:version/groups/:id/drivers GET /:version/groups/:id/fleet_managers GET /:version/groups/:id/vehicles POST /:version/groups/:id/users POST /:version/groups/:id/vehicles DELETE /:version/groups/:id/users DELETE /:version/groups/:id/vehicles |
| ELDs | - Read | GET /:version/eld_devices |
| Inspection Reports | - Read | GET /:version/inspection_reports |
| Fault Codes | - Read | GET /:version/fault_codes |
| Scorecards | - Read | GET /:version/driver_performance_events |
| Drivers with Available Time | - Read | GET /:version/available_time |
| Drivers with Hours of Service | - Read | GET /:version/hours_of_service |
| HOS Violations | - Read | GET /:version/hos_violations |
| HOS Logs | - Read | GET /:version/logs |
| Vehicles with Current Location and Current Driver | - Read | GET /:version/vehicle_locations |
| Vehicle Location History | - Read | GET /:version/vehicle_locations/:vehicle_id |
| Drivers with Current Location and Current Vehicle | - Read | GET /:version/driver_locations |
| IFTA Trip Reports | - Read | GET /:version/ifta/trips |
| Vehicles' Mileage Summary | - Read | GET /:version/ifta/summary |
| Utilization Summary by Driver | - Read | GET /:version/driver_utilization |
| Utilization Summary by Vehicle | - Read | GET /:version/vehicle_utilization |
| Utilization Records | - Read | GET /:version/idle_events |
| Documents | - Read | GET /:version/documents GET /:version/documents/:id |
| Company Details | - Read | GET /:version/companies |
| Dispatch Forms | - Read | GET /:version/forms |
| Dispatch Form Entries | - Read | GET /:version/form_entries |
| Dispatch Locations | - Read - Write | GET /:version/dispatch_locations POST /:version/dispatch_locations PUT /:version/dispatch_locations DELETE /:version/dispatch_locations |
| Dispatches | - Read - Write | GET /:version/dispatches POST /:version/dispatches PUT /:version/dispatches |
| Geofences | - Read - Write | GET /:version/geofences POST /:version/geofences GET /:version/geofences/:id PUT /:version/geofences/:id DELETE /:version/geofences/:id |
| Geofence Events | - Read | GET /:version/geofences/events |
| Documents | - Read - Write | GET /:version/documents POST /:version/documents GET /:version/documents/:id PUT /:version/documents/:id DELETE /:version/documents/:id |
| Assets | - Read | GET /:version/assets GET /:version/assets/lookup_by_external_id |
| Freight Visibility | - Read - Write | GET /:version/freight_visibility/vehicle_locations POST /:version/freight_visibility/subscribe PUT /:version/freight_visibility/subscribe GET /:version/freight_visibility/companies GET /:version/freight_visibility/vehicle_association GET /:version/freight_visibility/vehicle_subscriptions |
| Asset with Asset Gateway Location History | - Read | GET /:version/asset_locations GET /:version/asset_locations/:id |