Account

APIs to manage user accounts hosted by MiX Telematics systems.

Requests the authenticated user's account profile.

Requests the rate limit status for the authenticated user account.

Requests the month-to-date hit count statistics for the authenticated user account.

Requests the hit count statistics for last month for the authenticated user account.


Authentication

APIs to facilitate the authentication of a user account. You must authenticate before accessing any other resources else '401 Unauthorised' will be returned.

Requests an authentication token for the specified user account. Credentials can either be passed in the HTTP Authorization header (in the format "user username:password") or via the "username" and "password" query string parameters.

Submits authentication credentials to authenticate a user account. Credentials can either be passed in the HTTP Authorization header (in the format "user username:password") in which case the body can be omitted, or within a Credentials resource.


Devices

APIs to manage the details of devices hosted by MiX Telematics systems.

Requests the details of devices visible to the authenticated user.


Driver Hours Of Service

APIs to manage hours of service of drivers hosted by MiX Telematics systems.

Requests hours of service snapshots for the specified driver/s.


Drivers

APIs to manage drivers hosted by MiX Telematics systems.

Requests the details of drivers visible to the authenticated user.


Driver Work State Changes

APIs to manage driver work state changes of drivers hosted by MiX Telematics systems.

Requests work state changes for drivers visible to the authenticated user which occurred on or after the specified :since parameter.

Requests work state changes for drivers visible to the authenticated user which occurred between the specified :from and :to parameters.


Events

APIs to manage events from vehicles hosted by MiX Telematics systems.

Requests the latest event/s for vehicles or drivers visible to the authenticated user.

Requests events for vehicles or drivers visible to the authenticated user which occurred on or after the specified :since parameter.

Requests events for vehicles or drivers visible to the authenticated user which occurred between the specified :from and :to parameters.

Requests event summary data for vehicles visible to the authenticated user summarising events which occurred between the specified :from and :to parameters.


Event Types

APIs to manage event types from MiX Telematics systems.

Requests the list of event types.


Geocoding

APIs to perform geocoding requests against MiX Telematics systems.

Performs a reverse geocoding operation using the specified system to determine the location/address at the specified longitude and latitude.

Performs reverse geocoding operations using the specified system to determine the locations/addresses at each coordinate in the specified list of coordinates.


Globalisation

APIs to retrieve globalisation information.

Requests the list of culture information.

Requests the list of time zone information.


Locations

APIs to manage locations hosted by MiX Telematics systems.

Requests the details of locations visible to the authenticated user.


Organisations

APIs to manage the details of organisations hosted by MiX Telematics systems.

Requests the details of organisations visible to the authenticated user.


Passengers

APIs to manage passengers hosted by MiX Telematics systems.

Requests the details of passengers visible to the authenticated user.


Positions

APIs to manage positions from vehicles hosted by MiX Telematics systems.

Requests the latest position/s for vehicles or drivers visible to the authenticated user.

Requests positions for vehicles or drivers visible to the authenticated user which were generated on or after the specified :since parameter.

Requests positions for vehicles or drivers visible to the authenticated user which were generated between the specified :from and :to parameters.


Search

APIs to facilitate searching for entities hosted by MiX Telematics systems.

Searches for entities visible to the authenticated user.


Sites

APIs to manage sites hosted by MiX Telematics systems.

Requests the details of sites visible to the authenticated user.


Trips

APIs to manage trips from vehicles hosted by MiX Telematics systems.

Requests the latest trip/s for vehicles visible to the authenticated user.

Requests trips for vehicles or drivers visible to the authenticated user which occurred on or after the specified :since parameter.

Requests trips for vehicles or drivers visible to the authenticated user which occurred between the specified :from and :to parameters.

Requests trip summary data for vehicles visible to the authenticated user summarising trips which occurred between the specified :from and :to parameters.


Vehicles

APIs to manage vehicles hosted by MiX Telematics systems.

Requests the details of vehicles visible to the authenticated user.