# MCF APIs ## Docs - [Driver Alert History](https://docs.connectedfleet.michelin.com/api-reference/alert/driver-alert-history.md): Returns details of alerts that were triggered for a driver in the specified period.
The value specified for the endDate cannot be before startDate and the period cannot be more than 7 days.
Either driverId or groupId must be specified.
If driverId is specified, then only alerts for the s… - [Vehicle Alert History](https://docs.connectedfleet.michelin.com/api-reference/alert/vehicle-alert-history.md): Returns details of alerts that were triggered for a vehicle in the specified period.
The value specified for the endDate cannot be before startDate and the period cannot be more than 7 days.
Either vehicleId or groupId must be specified.
If vehicleId is specified, then only alerts for th… - [Add Driver](https://docs.connectedfleet.michelin.com/api-reference/driver/add-driver.md): POST request to add a new driver.
When adding a new driver, the identifier for the newly added driver is included in the JSON object returned as the response.
The details for the driver are in a JSON object included in the HTTP body.
Ensure you have set the content-type of the request bo… - [Delete Driver](https://docs.connectedfleet.michelin.com/api-reference/driver/delete-driver.md): DELETE request to delete a driver that matches the {driverId}. - [Delete Driver Default Vehicle](https://docs.connectedfleet.michelin.com/api-reference/driver/delete-driver-default-vehicle.md): DELETE request to delete the default vehicle for a driver.
An error is returned in the following cases: - [Enable Driver as a User](https://docs.connectedfleet.michelin.com/api-reference/driver/enable-driver-as-a-user.md): POST request to enable a driver as a Connect Web User.
You cannot include the password for the new user in the same request as enabling the driver as a user, instead you must use the Set User Password endpoint and include the token from the output response of this endpoint.
The generated tok… - [List Driver](https://docs.connectedfleet.michelin.com/api-reference/driver/list-driver.md): Returns details for all drivers and the group they have been assigned to. - [List Driver Details](https://docs.connectedfleet.michelin.com/api-reference/driver/list-driver-details.md): Returns details for a driver including their default vehicle. - [Set Driver Default Vehicle](https://docs.connectedfleet.michelin.com/api-reference/driver/set-driver-default-vehicle.md): POST request to set the default vehicle for a driver to the specified {vehicleId}.
An error is returned in the following cases: - [Update Driver](https://docs.connectedfleet.michelin.com/api-reference/driver/update-driver.md): PUT request to update the details for an existing driver.
This is a partial update and only those values specified will be updated.
The update details for the driver are in a JSON object included in the HTTP body.
Ensure you have set the content-type of the request body to "application/j… - [Driver Behaviour Driver Summary](https://docs.connectedfleet.michelin.com/api-reference/driverbehaviourmetrics/driver-behaviour-driver-summary.md): Returns the driver behaviour summary metrics for a driver.
The value specified for the endDate cannot be before startDate and the date range between startDate and endDate must be at least 7 days and cannot be more than 31 days.
A value for either driverId or groupId must be specified.
If… - [Driver Behaviour Group Metrics](https://docs.connectedfleet.michelin.com/api-reference/driverbehaviourmetrics/driver-behaviour-group-metrics.md): POST request to return behaviour metrics for a group for the specified period.
The value specified for the endDate cannot be before startDate and the date range between startDate and endDate should be at least 7 days.
The details for the user are in a JSON object included in the HTTP body.The value specified for the endDate cannot be before startDate and the date range between startDate and endDate should be at least 7 days.
The details for the user are in a JSON object included in the HTTP body.
Ensure… - [Driver Behaviour Metrics](https://docs.connectedfleet.michelin.com/api-reference/driverbehaviourmetrics/driver-behaviour-metrics.md): POST request to return the behaviour metrics for each day in the period for a driver.
As well as a value for the behaviour metric for each day, the response also includes a value for the behaviour metric for the whole of the specified period.
The value specified for the endDate cannot be bef… - [Driver Behaviour Vehicle Summary](https://docs.connectedfleet.michelin.com/api-reference/driverbehaviourmetrics/driver-behaviour-vehicle-summary.md): Returns the behaviour summary metrics for a vehicle.
The value specified for the endDate cannot be before startDate and the date range between startDate and endDate must be at least 7 days and cannot be more than 31 days.
A value for either vehicleId or groupId must be specified.
If ther… - [Driver Score](https://docs.connectedfleet.michelin.com/api-reference/ecoscore/driver-score.md): The Driver Behaviour endpoints (summary, metrics, group metrics and Group Ranking) should be used instead of EcoDrive Driver Score.
Returns the score for a driver based on journeys that started in the specified period.
The end date of the journey does not have to be within the specified peri… - [Driver Score Events](https://docs.connectedfleet.michelin.com/api-reference/ecoscore/driver-score-events.md): Returns the driver score driving events that occurred for a journey where the journey started in the specified period.
The end date of the journey does not have to be within the specified period.
Events that occurred during a private journey are included in the response, unless the "exclude… - [Vehicle Score Events](https://docs.connectedfleet.michelin.com/api-reference/ecoscore/vehicle-score-events.md): Returns the vehicle score driving events that occurred during a journey where the journey started in the specified period.
The end date of the journey does not have to be within the specified period.
Events that occurred during a private journey are included in the response unless the "exclu… - [Driver Fuel Consumption](https://docs.connectedfleet.michelin.com/api-reference/fuel/driver-fuel-consumption.md): Returns the fuel consumption and CO2 information for all journeys where the journey started in the period.
The end date of the journey does not have to be within the period.
Separate fuel consumption details are returned for each vehicle driven by a driver.
Includes the fuel used on a pr… - [Vehicle Fuel Consumption](https://docs.connectedfleet.michelin.com/api-reference/fuel/vehicle-fuel-consumption.md): Returns the fuel consumption and CO2 information for a vehicle for all journeys where the journey started within the period.
The end date of the journey does not have to be within the period.
Includes the fuel used on a private journey.
If vehicleId or groupId is not specified, then deta… - [Add Group](https://docs.connectedfleet.michelin.com/api-reference/group/add-group.md): POST request to add a new group.
The identifier for the newly added group is included in the JSON object returned as the response.
The request will fail when the group name contains illegal characters.
The details for the location category in a JSON object included in the HTTP body.
… - [Delete Group](https://docs.connectedfleet.michelin.com/api-reference/group/delete-group.md): DELETE request to delete the group that matches the {groupId}. - [List Group](https://docs.connectedfleet.michelin.com/api-reference/group/list-group.md): Returns the group hierarchy starting from the root node. - [Update Group](https://docs.connectedfleet.michelin.com/api-reference/group/update-group.md): PUT request to update the group that matches the {id} in the JSON object included in the HTTP body.
This is a partial update and only those details specified in the JSON body will be updated.
The request will fail when the updated group name contains illegal characters.
The details for t… - [Driver Idling](https://docs.connectedfleet.michelin.com/api-reference/idling/driver-idling.md): Returns idling details for a driver for each idling activity block that started in the specified period.
No details for idling that occurred inside a private journey.
The end date of the idling activity block does not have to be within the specified period.
The value specified for the en… - [Vehicle Idling](https://docs.connectedfleet.michelin.com/api-reference/idling/vehicle-idling.md): Returns idling details for a vehicle for each idling activity block that started in the specified period.
No details for idling that occurred inside a private journey are returned.
The end date of the idling activity block does not have to be within the specified period.
The value specif… - [Driver Input Usage](https://docs.connectedfleet.michelin.com/api-reference/input/driver-input-usage.md): Returns input usage details for each instance when an input on a vehicle was activated on a vehicle driven by the driver in the specified period.
The input deactivation does not have to be within the specified period.
Details of an input activated during a private journey are not included in… - [Vehicle Input Usage](https://docs.connectedfleet.michelin.com/api-reference/input/vehicle-input-usage.md): Returns input usage details for each instance when an input on a vehicle was activated in the specified period.
The input deactivation does not have to be within the specified period.
Details of an input activated during a private journey are not included in the response.
The value speci… - [Create Job](https://docs.connectedfleet.michelin.com/api-reference/job/create-job.md): POST request to create a job. The job details are in a JSON object included in the HTTP body. The minimum details required to create a job are: jobTitle clientName scheduledStartDateTime Delivery address : either address or values for lng and lat - [Delete Job](https://docs.connectedfleet.michelin.com/api-reference/job/delete-job.md): DELETE request to delete a job. The response includes summary details of the job that has been deleted. - [List jobs](https://docs.connectedfleet.michelin.com/api-reference/job/list-jobs.md): POST request to retrieve a list of jobs. Jobs are ordered in ascending scheduledStartDateTime order. - [Obtain a pre-signed URL](https://docs.connectedfleet.michelin.com/api-reference/job/obtain-a-pre-signed-url.md): POST request to generate a presigned post - [Overlapping jobs](https://docs.connectedfleet.michelin.com/api-reference/job/overlapping-jobs.md): GET request to retrieve a list of jobs where the window defined by scheduled start and planned duration overlaps with another job scheduled for the same resource. The request is limited to future jobs, a 24-hour window and only jobs with duration e.g. 0 mins jobs are omitted. - [Update job status](https://docs.connectedfleet.michelin.com/api-reference/job/update-job-status.md): POST request to update just the status of an existing job. If the new status is NEW, then any assigned driver or vehicle will be removed. - [Updated Since](https://docs.connectedfleet.michelin.com/api-reference/job/updated-since.md): GET request to retrieve a list of jobs. Like the “List Job” API (See 5.6) , however, returns jobs results that have updates since a specific date/time. The updatedSince cannot be more than 7 days in the past. - [Driver Journeys](https://docs.connectedfleet.michelin.com/api-reference/journeydetail/driver-journeys.md): Returns summary journey details for a driver for each journey that started in the specified period.
For a private journey only limited details are returned.
The end date of the journey does not have to be within the specified period.
The value specified for the endDate cannot be before s… - [Driver Journeys Latest](https://docs.connectedfleet.michelin.com/api-reference/journeydetail/driver-journeys-latest.md): Returns summary journey details for a driver for each journey that was processed by Connect since the specified date/time.
For a private journey only limited details are returned.
To use this endpoint to return details for only those drivers where the journey was processed since a specified… - [Vehicle Journeys](https://docs.connectedfleet.michelin.com/api-reference/journeydetail/vehicle-journeys.md): Returns summary journey details for a vehicle for each journey that started in the specified period.
For a private journey only limited details are returned.
The end date of the journey does not have to be within the specified period.
The value specified for the endDate cannot be before… - [Vehicle Journeys Latest](https://docs.connectedfleet.michelin.com/api-reference/journeydetail/vehicle-journeys-latest.md): Returns summary journey details for a vehicle for each journey that was processed by Connect since the specified date/time.
For a private journey only limited details are returned.
To use this endpoint to return details for only those vehicles where the journey was processed since a specifie… - [Add Location](https://docs.connectedfleet.michelin.com/api-reference/location/add-location.md): POST request to add a new location with a geo-fence boundary that can be either CIRCULAR or POLYGON.
There cannot be an existing location with the same name as the location being created.
The maximum number of POI that can be created in your account is limited based on the number of vehicles… - [Delete Location](https://docs.connectedfleet.michelin.com/api-reference/location/delete-location.md): DELETE request to delete a location that matches the {locationId}. - [List Location](https://docs.connectedfleet.michelin.com/api-reference/location/list-location.md): Returns the location (points of interest) matching the specified parameters.
If no parameters are specified, then all locations are returned.
If there are more than 50 locations, then by default only the first 50 locations are returned.
To view details of the other locations you will nee… - [Update Location](https://docs.connectedfleet.michelin.com/api-reference/location/update-location.md): PUT request to update location details.
The identifier for the location to be updated is included in the JSON body.
This is a partial update and only those details specified in the JSON body will be updated.
The updated address for the location can be specified as just the longitude and… - [Add or update Location Category](https://docs.connectedfleet.michelin.com/api-reference/locationcategory/add-or-update-location-category.md): PUT request to add a new location category.
The identifier for the newly added location category is included in the JSON object returned as the response or update the location category that matches the {id} in the JSON object included in the HTTP body.
The details for the location category i… - [Delete Location Category](https://docs.connectedfleet.michelin.com/api-reference/locationcategory/delete-location-category.md): DELETE request to delete the location category that matches the {categoryId}. - [Get Location Category](https://docs.connectedfleet.michelin.com/api-reference/locationcategory/get-location-category.md): Returns details for a specific location category. - [List Location Category](https://docs.connectedfleet.michelin.com/api-reference/locationcategory/list-location-category.md): Returns details for all location categories.
If a location category identifier is specified, then only details of the specified location category are returned. - [List Role](https://docs.connectedfleet.michelin.com/api-reference/role/list-role.md): Returns all roles and the active features for each role. - [List Role Details](https://docs.connectedfleet.michelin.com/api-reference/role/list-role-details.md): Returns details for a single role. - [Driver Speeding Detail](https://docs.connectedfleet.michelin.com/api-reference/speeding/driver-speeding-detail.md): Returns details for speeding episodes that occurred within the specified period.
The end of the speeding episode does not have to be within the specified period.
No details are returned for speeding episodes during a private journey.
The value specified for the endDate cannot be before s… - [Latest speeding events for a driver](https://docs.connectedfleet.michelin.com/api-reference/speeding/latest-speeding-events-for-a-driver.md): Returns the latest set of speeding events for the specified driver, by customerId and driverId - [Latest speeding events for a vehicle](https://docs.connectedfleet.michelin.com/api-reference/speeding/latest-speeding-events-for-a-vehicle.md): Returns the latest set of speeding events for the specified vehicle, by customerId and assetId - [Vehicle Speeding Detail](https://docs.connectedfleet.michelin.com/api-reference/speeding/vehicle-speeding-detail.md): Returns details for speeding episodes that occurred within the specified period.
The end of the speeding episode does not have to be within the specified period.
No details are returned for speeding episodes during a private journey.
The value specified for the endDate cannot be before s… - [Tacho Activity](https://docs.connectedfleet.michelin.com/api-reference/tacho/tacho-activity.md): Returns historical driver tacho activities. - [Tacho Default Settings](https://docs.connectedfleet.michelin.com/api-reference/tacho/tacho-default-settings.md): Returns the default tacho settings. - [Tacho Get Settings](https://docs.connectedfleet.michelin.com/api-reference/tacho/tacho-get-settings.md): Update the tacho settings. - [Tacho Live](https://docs.connectedfleet.michelin.com/api-reference/tacho/tacho-live.md): This provides the latest known tachograph status and aggregated time counters for a set of drivers. It is designed to power real-time operational systems such as Transport Management Systems (TMS) or workforce productivity tools by supplying up-to-date driving, working, and rest times for active dri… - [Tacho Update Settings](https://docs.connectedfleet.michelin.com/api-reference/tacho/tacho-update-settings.md): Update the tacho settings. - [List Vehicles Pending Pressure Inspection](https://docs.connectedfleet.michelin.com/api-reference/tire/list-vehicles-pending-pressure-inspection.md): Retrieve a list of vehicles that have not undergone tire pressure inspection since a specified timestamp, or have never been inspected. Results are sorted by inspection date in ascending order (oldest first). Optionally include the vehicle's last known GPS location. This endpoint helps identify vehi… - [List Vehicles Pending Wear Inspection](https://docs.connectedfleet.michelin.com/api-reference/tire/list-vehicles-pending-wear-inspection.md): Retrieve a list of vehicles that have not undergone tire wear inspection since a specified timestamp, or have never been inspected. Results are sorted by inspection date in ascending order (oldest first). Optionally include the vehicle's last known GPS location and address information. This endpoint… - [Tire Defect Events](https://docs.connectedfleet.michelin.com/api-reference/tire/tire-defect-events.md): Get tire defect history for one or more vehicles within a specified date range (not exceeding 6 months). Filter by severity level, specific vehicle (assetId), or group. Returns comprehensive defect information including category, type, entity type, severity, expected resolution date, and detailed pr… - [Tire events](https://docs.connectedfleet.michelin.com/api-reference/tire/tire-events.md): Get the latest tire pressure and wear inspection data for one or more vehicles. You can filter by specific vehicle (assetId) or group, specify inspection types, include location information, and apply pagination. This endpoint returns comprehensive tire condition information including pressure, temp… - [Tire Pressure Events](https://docs.connectedfleet.michelin.com/api-reference/tire/tire-pressure-events.md): Get historical tire pressure measurements and inspection data for a specific vehicle and Identifier of a vehicle. Retrieve data within a specified date range with optional pagination. The default date range is 30 days if not specified. Returns detailed pressure readings, temperature data, and sensor… - [Tire Wear Events](https://docs.connectedfleet.michelin.com/api-reference/tire/tire-wear-events.md): Get historical tire wear measurements and inspection data for a specific vehicle and Identifier of a vehicle. Retrieve data within a specified date range with mandatory start and end dates and optional pagination. Returns tread depth measurements by groove, inspection status, and additional tire con… - [Driver Tracking History](https://docs.connectedfleet.michelin.com/api-reference/trackinghistory/driver-tracking-history.md): Returns the journey tracking history for a driver for each journey that started in the specified period.
No details are returned for a private journey.
The end date of the journey does not have to be within the specified period.
The value specified for the endDate cannot be before startD… - [Driver Tracking History Latest](https://docs.connectedfleet.michelin.com/api-reference/trackinghistory/driver-tracking-history-latest.md): Returns the latest tracking events that have been processed by Connect for a driver since the specified date.
No details are returned for a private journey.
An error is returned if the value specified for fromDateTime is more than 14 days in the past or is a future date.
The output respo… - [Vehicle Tracking History](https://docs.connectedfleet.michelin.com/api-reference/trackinghistory/vehicle-tracking-history.md): Returns the journey tracking history for a vehicle for each journey that started in the specified period.
No details are returned for a private journey.
The end date of the journey does not have to be within the specified period.
The value specified for the endDate cannot be before start… - [Vehicle Tracking History Latest](https://docs.connectedfleet.michelin.com/api-reference/trackinghistory/vehicle-tracking-history-latest.md): Returns the latest tracking events that have been processed by Connect for a vehicle since the specified date.
No details are returned for a private journey.
An error is returned if the value specified for fromDateTime is more than 14 days in the past or is a future date.
The output resp… - [Latest Live Position GeoJSON](https://docs.connectedfleet.michelin.com/api-reference/trackinglive/latest-live-position-geojson.md): Fetches latest detailed tracking inputs with pagination and starting with the most recent entry based on filtering.
Produces GeoJSON format response. - [Live Position](https://docs.connectedfleet.michelin.com/api-reference/trackinglive/live-position.md): Returns the live position and status for a resource (driver or vehicle).
The live position for a vehicle on a private journey is not returned.
By default vehicles which have a status of SOLD are not included in the response.
- [Live Position AEMP](https://docs.connectedfleet.michelin.com/api-reference/trackinglive/live-position-aemp.md): Returns the live position and status for all vehicles in AEMP XML format.
Request Limit: The request limit on this endpoint is one request every 15 seconds. - [Live Position GeoJSON](https://docs.connectedfleet.michelin.com/api-reference/trackinglive/live-position-geojson.md): Gives detailed tracking inputs starting with the most recent entry based on filtering.
Produces GeoJSON format response. - [Live Position Latest](https://docs.connectedfleet.michelin.com/api-reference/trackinglive/live-position-latest.md): Returns the live position and status for a resource (driver or vehicle).
This endpoint can be used to return details for only those vehicles where tracking data has been processed since a specified processed date/time. - [Live Position Latest AEMP](https://docs.connectedfleet.michelin.com/api-reference/trackinglive/live-position-latest-aemp.md): Returns the latest live position and status for a vehicle in AEMP format.
Request Limit: The request limit on this endpoint is one request every 15 seconds. - [Add User](https://docs.connectedfleet.michelin.com/api-reference/user/add-user.md): POST request to add a web user.
You cannot include the password for the new user in the same request as adding a user, instead you must use the Set User Password endpoint and include the token from the output response of this endpoint.
The generated token will expire if it is not used within… - [Delete User](https://docs.connectedfleet.michelin.com/api-reference/user/delete-user.md): DELETE request to delete a user that matches the {userId}. - [List User](https://docs.connectedfleet.michelin.com/api-reference/user/list-user.md): Returns details for all active users.
No details are returned for inactive users.
If there are more than 50 users, then by default only details for the first 50 users are returned.
To view details for the other users you will need to specify values for pageSize and pageIndex. - [List User Details](https://docs.connectedfleet.michelin.com/api-reference/user/list-user-details.md): Returns details for a single user. - [Password Reset Token](https://docs.connectedfleet.michelin.com/api-reference/user/password-reset-token.md): GET request to generate a password reset token.
The token is used to update the password for an existing user.
The generated token will expire if it is not used within 24 hours or if another password reset token is requested.
A password reset token cannot be requested for a user enabled… - [Set User Password](https://docs.connectedfleet.michelin.com/api-reference/user/set-user-password.md): POST request to set the password for a user.
You must include the token generated when a new user was added or when a password reset token was requested.
A password cannot be set for a user enabled for SSO, i.e.
a value for externalIdentifier has been set.
The details for the passwor… - [Update User](https://docs.connectedfleet.michelin.com/api-reference/user/update-user.md): PUT request to update an existing user.
This is a partial update and only those values specified will be updated.
You cannot use this endpoint to update the username or the password for an existing user.
To update the password you must first get a token from the Password Reset Token endp… - [Driver Utilisation Hours](https://docs.connectedfleet.michelin.com/api-reference/utilisation/driver-utilisation-hours.md): Returns summary utilisation information for a driver for all journeys where the journey started in the specified period.
The end date of the journey does not have to be within the period.
If the vehicle driven by the driver has been configured for a PTO, then driving and idling time with PTO… - [Vehicle Utilisation Hours](https://docs.connectedfleet.michelin.com/api-reference/utilisation/vehicle-utilisation-hours.md): Returns summary utilisation information for a vehicle for all journeys where the journey started in the period.
The end date of the journey does not have to be within the period.
If the vehicle has been configured for a PTO, then driving and idling time with PTO active and with PTO inacti… - [Get Image](https://docs.connectedfleet.michelin.com/api-reference/vehicle-checks/get-image.md): GET request to return an image - [List Inspections](https://docs.connectedfleet.michelin.com/api-reference/vehicle-checks/list-inspections.md): Returns vehicle checks for a specified date range, filtered by vehicle, driver, or group. You must provide at least one of vehicleName, personName, or groupName to define the scope of the results. - [Update Defect Status](https://docs.connectedfleet.michelin.com/api-reference/vehicle-checks/update-defect-status.md): PUT request to update defect status. - [Find Nearest Vehicles](https://docs.connectedfleet.michelin.com/api-reference/vehicle/find-nearest-vehicles.md): Find vehicles nearest to a specified location or coordinate within a given radius. - [List Vehicle](https://docs.connectedfleet.michelin.com/api-reference/vehicle/list-vehicle.md): Returns the registration, group and current odometer reading for a vehicle.
The odometer reading is in kilometres.
If no parameters are specified, then details for all vehicles are returned.
Input parameters that can be specified are: