API Reference

Changelog

18-Dec-2024

Updated

17-Dec-2024

Added

Updated

  • New Query parameter added to GET/v2/documents endpoint: We have now added a new query parameter "updated_after", that will allow companies to fetch the documents that have been updated at a later point of time.

2-Dec-2024

Updated

1-Oct-2024

Updated

  • The following two parameters are added to the request body of POST/v1/vehicles, and PUT/v1/vehicles /{id} endpoints. The response will also contain these parameters:
    • driver_facing_camera
    • incab_audio_recording

NOTE: Apart from the above endpoints, these two parameters will also appear in the response of GET/v1/vehicles, GET/v1/vehicles/{ID}.

17-Sep-2024

Updated

  • User validations for POST v1/user and PUT v1/users/:id

17-Apr-2024

Added

  • GET v3/vehicle_locations

Updated

  • Add group_ids in POST v1/vehicles and PUT v1/vehicles/:id

29-Nov-2022

Added

  • Company Webhooks overview section updated

6-Jan-2022

Added

  • calibrated_start_odometer and calibrated_end_odometer to the API response for GET /v1/ifta/trips

27-Dec-2021

Added

  • GET /v2/dispatches
  • POST /v2/dispatches
  • PUT /v2/dispatches

2-Sep-2021

Added

  • GET /v2/vehicle_locations
  • GET /v3/vehicle_locations/:id

2-Aug-2021

Added

  • created_at and updated_at timestamps to all Vehicle APIs

4-May-2021

Added

  • Section titled HTTP Version

4-Jan-2021

Added

  • POST /v1/assets

19-Oct-2020

Updated

  • Add phone to the response of all dispatch_locations APIs. Phone can be passed as an attribute in request body for POST /v1/dispatch_locations and PUT /v1/dispatch_locations APIs.

21-Sep-2020

Updated

  • Add current_driver to GET /v1/freight_visibility/vehicle_locations API.

8-Sep-2020

Added

  • Section titled Information about source of a driving period for GET /v1/driving_periods API.

Updated

  • Source of a driving period is now returned as source in the response for GET /v1/driving_periods API.

31-Aug-2020

Updated

  • ID of log is now returned as log_id in the response of the inspection report APIs.

27-Aug-2020

Added

  • New section Request Content Type added with information about setting the correct value for the Content-Type HTTP Header.

18-Aug-2020

Updated

  • GET /v1/freight_visibility/vehicle_association.

29-Jun-2020

Added

  • GET /v1/assets
  • GET /v1/assets/lookup_by_external_id
  • GET /v1/asset_locations
  • GET /v1/asset_locations/:id

15-Jun-2020

Added

  • API to get inspection report object using external_id and integration_name via the GET /v1/inspection_reports/lookup_by_external_id API.

10-Jun-2020

Added

  • Changed Webhook request test payload.

18-May-2020

Added

  • External ids are returned for inspection report objects in the response for GET /v1/inspection_reports API.
    Documentation for inspection report update API.

11-May-2020

Added

  • ids and vendor_ids parameters to GET /v1/dispatches API.

21-Apr-2020

Added

  • doc_time added to response for GET /v1/documents and GET /v1/documents/:id APIs.
    External ids are returned for form objects in the response for GET /v1/forms API.

13-Apr-2020

Changed

  • The maximum per page limit for Geofences APIs changed from 100 to 500.

Added

  • auto_complete_forms can be passed as a body parameter to the POST|PUT v1/dispatches API.

7-Apr-2020

Added

  • GET /v1/freight_visibility/vehicle_locations
  • GET /v1/freight_visibility/companies
  • POST /v1/freight_visibility/subscribe
  • PUT /v1/freight_visibility/subscribe

6-Apr-2020

Added

  • Retry intervals for Webhook requests.
  • SLA for responding to webhook requests.
  • Documentation for Public Document creation API's.
  • updated_after query parameter added to GET /v1/fault_codes API.

11-Nov-2019

Added

  • updated_after query parameter to GET /v1/inspection_reports
  • dispatch_ids query parameter to GET /v1/form_entries
  • driver_ids query parameter to GET /v1/form_entries
  • vehicle_ids query parameter to GET /v1/form_entries
  • Documentation for Geofence Public API endpoints.