Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Vehicles

Get a list of vehicles

Retrieve a paged collection of vehicles (required scope vehicles:read)

get/v1/vehicles

Query parameters

sortBy'createdAt' | 'groupName' | 'registration'

Represents the sort options for vehicles<p>Possible values:</p><ul><li><b>createdAt</b>: Sort by created at date</li><li><b>groupName</b>: Sort by vehicle group</li><li><b>registration</b>: Sort by registration</li></ul>

Example:createdAt

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

registrationstring[]

Only return vehicles where registration matches with the value(s) provided (Max items: 50)

referencestring[]

Only return vehicles where reference matches the value(s) provided (Max items: 50)

idinteger[]

Only return resources where id matches the value(s) provided (Max items: 50)

groupIdinteger[]

Only return resources where groupId matches the value(s) provided (Max items: 50)

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": [
    {
      "id": 5514123,
      "createdAt": "2022-11-29T16:50:16.0000000+00:00",
      "groupId": 1211,
      "vehicleType": "motorcycle",
      "fixedResourceId": 1211,
      "groupName": "Vans",
      "reference": "ABC5514123",
      "registration": "BC24 BIG",
      "make": "Ford",
      "model": "Transit",
      "registrationYear": 2012,
      "isSchedulable": true,
      "idlingFuelConsumptionRate": 0.1,
      "costPerKm": 0.25,
      "costPerDay": 0.25,
      "costPerKmCurrencyCode": "EUR",
      "costPerDayCurrencyCode": "EUR",
      "odometerUnit": "miles",
      "odometerEstimate": 510200,
      "odometer": 51023,
      "odometerReadAt": "2022-11-29T16:50:16.0000000+00:00",
      "roadSafetyExpiresAt": "2022-11-29",
      "roadTaxExpiresAt": "2022-11-29",
      "serviceDueAt": "2022-11-29",
      "insuranceDueAt": "2022-11-29",
      "co2EmissionsGramsPerKm": 5,
      "co2EmissionsKilogramsPerLitre": 5.5,
      "customFields": [
        {
          "definitionId": 5514123,
          "value": "Purple",
          "definition": {
            "caption": "Favourite colour",
            "type": "boolean",
            "listOptions": [
              "Red",
              "Blue",
              "Green",
              "Purple"
            ],
            "isRequired": true,
            "isEditable": true,
            "default": "10"
          },
          "systemListValueMetadata": {
            "label": "John Doe",
            "entityType": "resource"
          }
        }
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}