--- title: "Get a list of vehicles" method: GET path: "/v1/vehicles" tags: ["Vehicles"] --- # Get a list of vehicles `GET /v1/vehicles` Retrieve a paged collection of vehicles (required scope vehicles:read) ## Query parameters - `sortBy` 'createdAt' | 'groupName' | 'registration' — Represents the sort options for vehicles

Possible values:

- `direction` 'ascending' | 'descending' — Represents the direction in which sorting should be applied

Possible values:

- `registration` string[] - `reference` string[] - `id` integer[] - `groupId` integer[] - `pageNumber` integer - `pageSize` integer ## Headers - `Customer-Id` integer, required ## Response `200` OK - PagedResponseReadVehicleModel — A paged collection of items - `items` ReadVehicleModel[] — The items returned for the requested page - `id` integer — The unique identifier of the vehicle - `createdAt` string, date-time — The UTC timestamp of when this vehicle was created - `groupId` integer — The unique identifier of the group that the vehicle belongs to - `vehicleType` 'motorcycle' | 'car' | 'trailer' | 'bus' | 'emergency' | 'goodsLess7_5T' | 'goodsMore7_5T' | 'busLess12' — Enumeration representing different types of vehicles

Possible values:

- `fixedResourceId` integer, nullable — The unique identifier of the resource who this vehicle is assigned to - `groupName` string — The name of the group that the vehicle belongs to - `reference` string — The internal reference of the vehicle - should usually be unique - `registration` string — The registration number of the vehicle - `make` string, nullable — The manufacturer of the vehicle - `model` string, nullable — The model of the vehicle - `registrationYear` integer, nullable — The year that the vehicle was first registered as new - `isSchedulable` boolean — Indicates whether this vehicle can be scheduled jobs - `idlingFuelConsumptionRate` number, double, nullable — The litre fuel consumption of the vehicle used when idling per minute - `costPerKm` number, double, nullable — The running cost of the vehicle per kilometre, expressed in `costPerKmCurrencyCode` - `costPerDay` number, double, nullable — The running cost of the vehicle per day, expressed in `costPerDayCurrencyCode` - `costPerKmCurrencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database

Possible values:

- `costPerDayCurrencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database

Possible values:

- `odometerUnit` 'miles' | 'kilometres' — The unit of measure for distance presented by the vehicles odometer

Possible values:

- `odometerEstimate` integer, nullable — An estimate of vehicle odometer reading, based on tracked distance - `odometer` integer, nullable — The latest reading from the vehicles odometer - `odometerReadAt` string, date-time, nullable — The UTC timestamp of when the odometer reading was last recorded - `roadSafetyExpiresAt` string, date, nullable — The date of when the vehicle's road safety test expires (eg. UK MOT test) - `roadTaxExpiresAt` string, date, nullable — The date of when the vehicle's road tax expires - `serviceDueAt` string, date, nullable — The date of when the vehicle's next service is due - `insuranceDueAt` string, date, nullable — The date of when the vehicle's insurance is due for renewal - `co2EmissionsGramsPerKm` integer, nullable — The vehicle co2 emission rate as (grams per km) - `co2EmissionsKilogramsPerLitre` number, double, nullable — The vehicle co2 emission rate as (kilograms per litre) - `customFields` CustomFieldReadModel[] — Custom fields associated with the vehicle - `definitionId` integer — The unique identifier of the associated custom field definition - `value` string, nullable — The current value set for the custom field - `definition` CustomFieldEmbeddedDefinitionModel — Represents the definition of a custom field - `caption` string — The caption of a custom field - `type` 'boolean' | 'integer' | 'decimal' | 'text' | 'list' | 'statement' | 'date' | 'note' | 'time' | 'systemList' — The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

Possible values:

- `listOptions` string[], nullable — Shows the possible values for a list type custom field. Value will be null if type is not list - `isRequired` boolean — Indicates if the field is required in the UI. This is NOT enforced in the API - `isEditable` boolean — Indicates if the field is editable - `default` string, nullable — The default value of a custom field. Formatted in accordance with the rules of the field type - `systemListValueMetadata` SystemListValueMetadataModel — Represents details of custom field value of type system list - `label` string, nullable — A descriptive label for the specific resource, vehicle or web user that this system list value relates to - `entityType` 'resource' | 'vehicle' | 'webUser' — The type of entity used for custom field value of type system list

Possible values:

- `pageNumber` integer — The page number of the response where 1 is the first page - `pageSize` integer — The number of items requested for the current page - `pageItemCount` integer — The number of items returned in the current page ## Other responses - `400` — Bad Request - `403` — Forbidden - `500` — Internal Server Error --- [API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)