BIbigchange
Vehicles

Get a list of vehicle checks

Changed on

Retrieve a paged collection of checks for a single vehicle (required scope vehicles:read)

get/v1/vehicles/{vehicleId}/checks

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/vehicles/{vehicleId}/checks
  • Auth
    HTTP bearer

Path parameters

vehicleIdinteger required

The unique identifier of the vehicle whose checks are retrieved

Query parameters

completedFromstring date-time

Only return checks completed on or after this date

completedTostring date-time

Only return checks completed on or before this date

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "checkId": 5514123,
      "vehicleId": 1211,
      "completedByResourceId": 1211,
      "completedAt": "2022-11-29T16:50:16.0000000+00:00",
      "createdAt": "2022-11-29T16:50:16.0000000+00:00"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes