Retrieve Vehicle

GET https://secure.fleetio.com/api/v1/vehicles/:id

Retrieve the details of an existing Vehicle.

Request

Path Parameters

id stringrequired

The Fleetio ID of the relevant Vehicle.

You may also look up Vehicles by their VIN, license plate, or other external ID. See the guide on External Vehicle Ids for information on how to set this up.

Responses

application/json

Schema
Example (auto)

Schema

idinteger

account_idinteger

archived_atdate-timenullable

The iso8601 date and time at which the vehicle was archived, for an archived vehicle.

Example: 2023-03-14T13:46:27-06:00

fuel_type_idintegernullable

fuel_type_namestringnullable

The name of the Fuel Type associated with this vehicle.

fuel_volume_unitsVolumeUnit (string)

Possible values: [us_gallons, uk_gallons, liters]

group_idintegernullable

group_namestringnullable

The name of the Group associated with this vehicle, for vehicles associated with a group.

namestring

This vehicle's name.

ownershipVehicleOwnershipResponse (string)

Possible values: [Owned, Leased, Rented, Customer]

current_location_entry_idintegernullable

system_of_measurementMeasurementSystem (string)

Possible values: [imperial, metric]

vehicle_type_idinteger

This vehicles Vehicle Type id.

vehicle_type_namestring

The name of the Vehicle Type associated with this Vehicle.

is_sampleboolean

Indicates whether this Vehicle record is Sample Data.

vehicle_status_idinteger

The id of the Vehicle Status of this vehicle.

vehicle_status_namestring

The name of the Vehicle Status associated with this Vehicle.

vehicle_status_colorstringnullable

The hex color code of the Vehicle Status associated with this Vehicle.

primary_meter_unitMeterUnit (string)nullable

The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

Possible values: [km, hr, mi]

primary_meter_valuestringnullable

The current value of the primary meter for this Vehicle.

primary_meter_datedate-timenullable

The date and time at which the primary meter was last updated.

Example: 2023-03-14T13:46:27-06:00

primary_meter_usage_per_daystringnullable

The average number of units of the primary meter used per day.

secondary_meter_unitMeterUnit (string)nullable

The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

Possible values: [km, hr, mi]

secondary_meter_valuestringnullable

The current value of the secondary meter for this Vehicle.

secondary_meter_datedate-timenullable

The date and time at which the secondary meter was last updated.

Example: 2023-03-14T13:46:27-06:00

secondary_meter_usage_per_daystringnullable

The average number of units of the secondary meter used per day.

in_service_meter_valuestringnullable

The meter value at which this Vehicle was put into service.

in_service_datedate-timenullable

The date on which this Vehicle was put into service.

Example: 2023-03-14T13:46:27-06:00

out_of_service_meter_valuestringnullable

The meter value at which this Vehicle was or will be retired.

out_of_service_datedate-timenullable

The date on which this Vehicle was or will be retired.

Example: 2023-03-14T13:46:27-06:00

estimated_service_monthsintegernullable

The estimated number of months this Vehicle will be in service.

estimated_replacement_mileagestringnullable

The estimated number of miles before which this Vehicle will be replaced.

estimated_resale_price_centsintegernullable

The estimated resale price of this Vehicle in cents.

fuel_entries_countinteger

The number of Fuel Entries associated with this Vehicle.

Possible values: >= 0

service_entries_countinteger

The number of Service Entries associated with this Vehicle.

Possible values: >= 0

service_reminders_countinteger

The number of Service Reminders associated with this Vehicle.

Possible values: >= 0

vehicle_renewal_reminders_countinteger

The number of Vehicle Renewal Reminders associated with this Vehicle.

Possible values: >= 0

comments_countinteger

The number of Comments associated with this Vehicle.

Possible values: >= 0

documents_countinteger

The number of documents attached to this Vehicle.

Possible values: >= 0

images_countinteger

The number of images attached to this Vehicle.

Possible values: >= 0

issues_countinteger

The number of Issues this Vehicle is associated with.

Possible values: >= 0

work_orders_countinteger

The number of Work Orders this Vehicle is associated with.

Possible values: >= 0

labels object[]

group_ancestrystringnullable

The ancestry of the Group associated with this Vehicle.

colorstringnullable

The color of this Vehicle.

license_platestringnullable

The license plate number of this Vehicle.

vinstringnullable

The Vehicle Identification Number of this Vehicle.

yearstringnullable

This Vehicle's model year.

makestringnullable

The name of this Vehicle's manufacturer.

modelstringnullable

The name of the model of this Vehicle.

trimstringnullable

The trim level of this Vehicle.

registration_expiration_monthintegernullable

The month in which this Vehicle's registration expires.

Possible values: >= 0 and <= 12

registration_statestringnullable

The state, province, or territory in which this Vehicle is registered.

default_image_url_smallstringnullable

The URL of a small-sized version of the default image for this Vehicle.

external_idsobject

Any External IDs associated with this Vehicle.

ai_enabledboolean

Whether this Vehicle has Auto Integrate enabled for it.

assetable_typestring

Assetable type for Vehicle is always Vehicle for vehicles.

Possible values: [Vehicle]

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

axle_config_idintegernullable

The id of the Axle Configuration of this vehicle.

meter_namestring

The name of the primary meter for this Vehicle.

secondary_meter_namestring

The name of the secondary meter for this Vehicle.

loan_account_numberstringnullable

The account number for this Vehicle's loan, if applicable.

loan_ended_atdate-timenullable

The date and time at which this Vehicle's loan ends.

Example: 2023-03-14T13:46:27-06:00

loan_interest_ratefloatnullable

The interest rate for this Vehicle's loan.

loan_notesstringnullable

Notes about this Vehicle's loan.

loan_started_atdate-timenullable

The date and time at which this Vehicle's loan began. Formatted according to ISO-8601 in User's local time.

Example: 2023-03-14T13:46:27-06:00

loan_vendor_idNullableId (integer)nullable

Possible values: >= 1

loan_vendor_namestringnullable

The name of the Vendor for this Vehicle's loan.

inspection_schedules_countinteger

The number of inspection schedules this Vehicle is associated with.

Possible values: >= 0

default_image_urlstringnullable

The URL of the default image for this Vehicle.

default_image_url_mediumstringnullable

The URL of a medium-sized version of the default image for this Vehicle.

default_image_url_largestringnullable

The URL of a large-sized version of the default image for this Vehicle.

specs object

idId (integer)

Possible values: >= 1

vehicle_idinteger

The Vehicle ID these specs belong to.

account_idinteger

body_typestringnullable

The body type of the Vehicle, if available.

body_subtypestringnullable

The subtype of the Vehicle body, if available.

drive_typestringnullable

The drive type of the Vehicle, if available.

brake_systemstringnullable

The brake system used in the Vehicle, if available.

msrp_centsintegernullable

The Manufacturer's Suggested Retail Price (MSRP) in cents, if available.

fuel_tank_capacityfloatnullable

The fuel tank capacity of the Vehicle, if available.

fuel_tank_2_capacityfloatnullable

The capacity of a second fuel tank, if available.

front_track_widthfloatnullable

The front track width of the Vehicle, if available.

ground_clearancefloatnullable

The ground clearance of the Vehicle, if available.

heightfloatnullable

The height of the Vehicle, if available.

lengthfloatnullable

The length of the Vehicle, if available.

rear_track_widthfloatnullable

The rear track width of the Vehicle, if available.

widthfloatnullable

The width of the Vehicle, if available.

wheelbasefloatnullable

The wheelbase of the Vehicle, if available.

front_tire_psistringnullable

The recommended PSI for front tires, if available.

rear_tire_psistringnullable

The recommended PSI for rear tires, if available.

base_towing_capacitystringnullable

The base towing capacity of the Vehicle, if available.

curb_weightfloatnullable

The curb weight of the Vehicle, if available.

gross_vehicle_weight_ratingfloatnullable

The Gross Vehicle Weight Rating (GVWR), if available.

bed_lengthstringnullable

The length of the Vehicle's bed, if available.

max_payloadstringnullable

The maximum payload capacity of the Vehicle, if available.

rear_axle_typestring

The type of rear axle used in the Vehicle.

front_tire_typestring

The type of front tires used in the Vehicle.

front_wheel_diameterstring

The diameter of the front wheels.

rear_tire_typestring

The type of rear tires used in the Vehicle.

rear_wheel_diameterstring

The diameter of the rear wheels.

epa_cityfloatnullable

The EPA city fuel economy rating, if available.

epa_highwayfloatnullable

The EPA highway fuel economy rating, if available.

epa_combinedfloatnullable

The combined EPA fuel economy rating, if available.

engine_descriptionstring

Description of the Vehicle's engine.

engine_brandstring

Brand of the Vehicle's engine.

engine_aspirationstringnullable

Aspiration type of the engine, if available.

engine_block_typestringnullable

Block type of the engine, if available.

engine_borestringnullable

Bore size of the engine, if available.

engine_cam_typestringnullable

Camshaft type of the engine, if available.

engine_compressionstringnullable

Compression ratio of the engine, if available.

engine_cylindersintegernullable

Number of engine cylinders, if available.

engine_displacementstringnullable

Engine displacement, if available.

fuel_inductionstringnullable

Fuel induction method, if available.

fuel_qualitystring

Fuel quality required for the engine.

max_hpstringnullable

Maximum horsepower produced by the engine, if available.

max_torquestringnullable

Maximum torque produced by the engine, if available.

oil_capacitystringnullable

Oil capacity of the engine, if available.

redline_rpmstring

Redline RPM of the engine.

engine_strokestringnullable

Stroke length of the engine, if available.

engine_valvesintegernullable

Number of engine valves, if available.

transmission_descriptionstring

Description of the Vehicle's transmission.

transmission_brandstring

Brand of the Vehicle's transmission.

transmission_typestringnullable

Type of transmission, if available.

transmission_gearsintegernullable

Number of gears in the transmission, if available.

cargo_volumefloatnullable

Cargo volume of the Vehicle, if available.

interior_volumefloatnullable

Interior volume of the Vehicle, if available.

passenger_volumestring

Passenger volume of the Vehicle.

created_atdate-time

The date and time when the specs were created.

updated_atdate-time

The date and time when the specs were last updated.

duty_typestringnullable

Type of duty the Vehicle is designed for, if available.

weight_classstringnullable

Weight class of the Vehicle, if available.

engine_bore_with_unitsstringnullable

Bore size of the engine with units, if available.

wheelbase_with_unitsstringnullable

Wheelbase of the Vehicle with units, if available.

msrpstringnullable

Manufacturer's Suggested Retail Price (MSRP).

driver object

current_location_entry objectnullable

{
  "id": 0,
  "account_id": 0,
  "archived_at": "2023-03-14T13:46:27-06:00",
  "fuel_type_id": 0,
  "fuel_type_name": "string",
  "fuel_volume_units": "us_gallons",
  "group_id": 0,
  "group_name": "string",
  "name": "string",
  "ownership": "Owned",
  "current_location_entry_id": 0,
  "system_of_measurement": "imperial",
  "vehicle_type_id": 0,
  "vehicle_type_name": "string",
  "is_sample": true,
  "vehicle_status_id": 0,
  "vehicle_status_name": "string",
  "vehicle_status_color": "string",
  "primary_meter_unit": "km",
  "primary_meter_value": "string",
  "primary_meter_date": "2023-03-14T13:46:27-06:00",
  "primary_meter_usage_per_day": "string",
  "secondary_meter_unit": "km",
  "secondary_meter_value": "string",
  "secondary_meter_date": "2023-03-14T13:46:27-06:00",
  "secondary_meter_usage_per_day": "string",
  "in_service_meter_value": "string",
  "in_service_date": "2023-03-14T13:46:27-06:00",
  "out_of_service_meter_value": "string",
  "out_of_service_date": "2023-03-14T13:46:27-06:00",
  "estimated_service_months": 0,
  "estimated_replacement_mileage": "string",
  "estimated_resale_price_cents": 0,
  "fuel_entries_count": 0,
  "service_entries_count": 0,
  "service_reminders_count": 0,
  "vehicle_renewal_reminders_count": 0,
  "comments_count": 0,
  "documents_count": 0,
  "images_count": 0,
  "issues_count": 0,
  "work_orders_count": 0,
  "labels": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "group_ancestry": "string",
  "color": "string",
  "license_plate": "string",
  "vin": "string",
  "year": "string",
  "make": "string",
  "model": "string",
  "trim": "string",
  "registration_expiration_month": 0,
  "registration_state": "string",
  "default_image_url_small": "string",
  "external_ids": {},
  "ai_enabled": true,
  "assetable_type": "Vehicle",
  "custom_fields": {},
  "axle_config_id": 0,
  "meter_name": "string",
  "secondary_meter_name": "string",
  "loan_account_number": "string",
  "loan_ended_at": "2023-03-14T13:46:27-06:00",
  "loan_interest_rate": 0,
  "loan_notes": "string",
  "loan_started_at": "2023-03-14T13:46:27-06:00",
  "loan_vendor_id": 0,
  "loan_vendor_name": "string",
  "inspection_schedules_count": 0,
  "default_image_url": "string",
  "default_image_url_medium": "string",
  "default_image_url_large": "string",
  "specs": {
    "id": 0,
    "vehicle_id": 0,
    "account_id": 0,
    "body_type": "string",
    "body_subtype": "string",
    "drive_type": "string",
    "brake_system": "string",
    "msrp_cents": 0,
    "fuel_tank_capacity": 0,
    "fuel_tank_2_capacity": 0,
    "front_track_width": 0,
    "ground_clearance": 0,
    "height": 0,
    "length": 0,
    "rear_track_width": 0,
    "width": 0,
    "wheelbase": 0,
    "front_tire_psi": "string",
    "rear_tire_psi": "string",
    "base_towing_capacity": "string",
    "curb_weight": 0,
    "gross_vehicle_weight_rating": 0,
    "bed_length": "string",
    "max_payload": "string",
    "rear_axle_type": "string",
    "front_tire_type": "string",
    "front_wheel_diameter": "string",
    "rear_tire_type": "string",
    "rear_wheel_diameter": "string",
    "epa_city": 0,
    "epa_highway": 0,
    "epa_combined": 0,
    "engine_description": "string",
    "engine_brand": "string",
    "engine_aspiration": "string",
    "engine_block_type": "string",
    "engine_bore": "string",
    "engine_cam_type": "string",
    "engine_compression": "string",
    "engine_cylinders": 0,
    "engine_displacement": "string",
    "fuel_induction": "string",
    "fuel_quality": "string",
    "max_hp": "string",
    "max_torque": "string",
    "oil_capacity": "string",
    "redline_rpm": "string",
    "engine_stroke": "string",
    "engine_valves": 0,
    "transmission_description": "string",
    "transmission_brand": "string",
    "transmission_type": "string",
    "transmission_gears": 0,
    "cargo_volume": 0,
    "interior_volume": 0,
    "passenger_volume": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "duty_type": "string",
    "weight_class": "string",
    "engine_bore_with_units": "string",
    "wheelbase_with_units": "string",
    "msrp": "string"
  },
  "driver": {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "full_name": "string",
    "default_image_url": "string"
  },
  "current_location_entry": {
    "id": 0,
    "locatable_type": "string",
    "locatable_id": 0,
    "date": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "contact_id": 0,
    "address": "string",
    "is_current": true,
    "item_type": "string",
    "item_id": 0,
    "location": "string",
    "address_components": {
      "street_number": "string",
      "street": "string",
      "city": "string",
      "region": "string",
      "region_short": "string",
      "country": "string",
      "country_short": "string",
      "postal_code": "string"
    },
    "geolocation": {
      "latitude": 0,
      "longitude": 0
    }
  }
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

The requested resource could not be located

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

CURL

curl -L 'https://secure.fleetio.com/api/v1/vehicles/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

ResponseClear

Click the Send API Request button above and see the response here!

Retrieve Vehicle

https://secure.fleetio.com/api/v1/vehicles/:id

Request​

Path Parameters

Responses​

Authorization: Authorization

Request

Responses