Skip to main content
GET
/
api
/
v1
/
vehicle-checks
/
inspections
List Inspections
curl --request GET \
  --url https://vehiclechecks-public-api.connectedfleet.michelin.com/public/bvfm/vehicle-checks/public-api/api/v1/vehicle-checks/inspections \
  --header 'Authorization: Bearer <token>'
{
  "inspections": [
    {
      "inspectionNumber": "<string>",
      "submittedDateTime": "2023-11-07T05:31:56Z",
      "inspectionDuration": "<string>",
      "personId": "<string>",
      "personName": "<string>",
      "vehicleId": "<string>",
      "vehicleName": "<string>",
      "groupName": "<string>",
      "address": "<string>",
      "lng": 123,
      "lat": "<string>",
      "checkResult": "PASSED",
      "repairStatus": "OPEN",
      "defects": [
        {
          "category": "<string>",
          "name": "<string>",
          "description": "<string>",
          "checkResult": "<string>",
          "note": "<string>",
          "repairStatus": "<string>",
          "photoIds": [
            "<string>"
          ],
          "defectId": "<string>"
        }
      ],
      "checks": [
        {
          "category": "<string>",
          "name": "<string>",
          "description": "<string>",
          "checkResult": "<string>",
          "note": "<string>"
        }
      ],
      "notes": "<string>",
      "contactName": "<string>",
      "contactPhone": "<string>",
      "odometer": 123,
      "make": "<string>",
      "model": "<string>",
      "completedTooQuickly": true,
      "statusChanges": [
        {
          "repairStatus": "<string>",
          "description": "<string>",
          "repairDate": "2023-11-07T05:31:56Z",
          "signature": "<string>",
          "statusChangeTimestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "odometerUnit": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dateTimeFrom

The period between dateTimeFrom and dateTimeTo cannot be more than 31 days.

Example:

"2022-12-12"

dateTimeTo

The period between dateTimeFrom and dateTimeTo cannot be more than 31 days.

Example:

"2022-12-12"

groupName
string

Group identifier (alphanumeric). Use this to retrieve data for all vehicles within a specific group. Must be specified if neither personName or vehicleName is specified.

personName
string[]

Name of the person who submitted the inspection. Must be specified if a value for either vehicleName or groupName is not specified. It supports a list of names.

vehicleName
string[]

Friendly name for the vehicle where inspection has been carried out. Must be specified if a value for either personName or groupName is not specified. It supports a list of names.

limit
integer

The number of inspections to include in the output. If not specified it will default to 200.

nextToken
string

Token returned in a previous call to this endpoint to get the next set of details.

Response

200 - application/jsonl

OK

inspections
object[]

Array of inspection information.