FleetbaseFleetbase

Vehicles

Vehicles represent fleet assets that can be tracked, assigned, and used to fulfill orders. Use vehicle endpoints to manage registration details, assignment state, live location, and operational status.

The Vehicle object

A vehicle represents a trackable asset used for Fleet-Ops assignment, routing, and capacity planning. It stores vehicle identity, status, assignment, current position, capacity, dimensions, engine and regulatory specifications, financing, orchestrator constraints, and metadata. Each relationship appears twice, and the two are separate keys. `<name>_id` is the related resource's public ID and is always present. `<name>` is the nested object and is returned only when the relationship was asked for through `?with=`; it is never a string. Internal uuid columns are never part of the public contract.
Attributes
idstringoptional

Public vehicle identifier.

internal_idstringoptional

Optional internal identifier.

photo_urlstringoptional

Vehicle photo URL.

avatar_urlstringoptional

Vehicle avatar URL.

namestringoptional

Vehicle display name.

descriptionstringoptional

Vehicle description.

driverobjectoptional

The assigned driver, returned only when requested through with=driver. Never a string — read driver_id for the identifier.

devicesarray of objectsoptional

Vehicle devices, when loaded.

makestringoptional

Vehicle manufacturer.

modelstringoptional

Vehicle model.

model_typestringoptional

Vehicle model type.

yearintegeroptional

Model year.

trimstringoptional

Vehicle trim.

typestringoptional

Vehicle type.

classstringoptional

Vehicle class.

colorstringoptional

Vehicle color.

serial_numberstringoptional

Vehicle serial number.

plate_numberstringoptional

License plate number.

call_signstringoptional

Vehicle call sign.

fuel_card_numberstringoptional

Fuel card number assigned to the vehicle.

vinstringoptional

Vehicle identification number.

vin_dataobjectoptional

Decoded VIN data.

specsobjectoptional

Vehicle specification data.

detailsobjectoptional

Additional vehicle detail data.

statusenumoptional

Vehicle operational status. active is accepted on input and stored as available. One of active, available, in_use, maintenance, out_of_service, reserved, retired, staging, on_route, idle, cleaning, awaiting_parts, inspection_due, inspection_failed, accident, compliance_hold, stolen, operational, decommissioned.

onlinebooleanoptional

Whether the vehicle is online.

slugstringoptional

URL-friendly vehicle slug.

financing_statusstringoptional

Vehicle financing status.

measurement_systemstringoptional

Measurement system used for vehicle metrics.

odometernumberoptional

Current odometer reading.

odometer_unitstringoptional

Unit for odometer readings.

fuel_typestringoptional

Vehicle fuel type.

payload_capacitynumberoptional

Payload capacity.

towing_capacitynumberoptional

Towing capacity.

seating_capacityintegeroptional

Seating capacity.

weightnumberoptional

Vehicle weight.

lengthnumberoptional

Vehicle length.

widthnumberoptional

Vehicle width.

heightnumberoptional

Vehicle height.

currencycurrencyoptional

Currency for vehicle financial fields.

acquisition_costcurrencyoptional

Acquisition cost.

current_valuecurrencyoptional

Current vehicle value.

purchased_attimestampoptional

Purchase timestamp.

lease_expires_attimestampoptional

Lease expiration timestamp.

deleted_attimestampoptional

Deletion timestamp when soft deleted.

updated_attimestampoptional

Timestamp when the vehicle was last updated.

created_attimestampoptional

Timestamp when the vehicle was created.

locationobjectoptional

Current vehicle coordinates.

headingintegeroptional

Current heading in degrees.

altitudeintegeroptional

Current altitude.

speedintegeroptional

Current speed.

telematicsobjectoptional

Telematics payload.

notesstringoptional

Vehicle notes.

metaobjectoptional

Additional vehicle metadata.

driver_idstringoptional

Public ID of the assigned driver, or null. Always present.

vendor_idstringoptional

Public ID of the assigned vendor, or null. Always present.

category_idstringoptional

Public ID of the assigned category, or null. Always present.

warranty_idstringoptional

Public ID of the assigned warranty, or null. Always present.

photo_idstringoptional

Public ID of the vehicle photo file, or null. Always present. photo_url beside it is a convenience URL, and avatar_url is a separate display asset that is not a file reference.

vendorobjectoptional

The assigned vendor, returned only when requested through with=vendor. Never a string — read vendor_id for the identifier.

categoryobjectoptional

The assigned category, returned only when requested through with=category.

warrantyobjectoptional

The assigned warranty, returned only when requested through with=warranty.

photoobjectoptional

The vehicle photo file, returned only when requested through with=photo.

skillsarray of stringsoptional

Capabilities the vehicle offers for orchestrator assignment.

payload_capacity_volumenumberoptional

Payload volume capacity used by orchestrator assignment.

payload_capacity_palletsintegeroptional

Pallet capacity used by orchestrator assignment.

payload_capacity_parcelsintegeroptional

Parcel capacity used by orchestrator assignment.

max_tasksintegeroptional

Maximum concurrent tasks for orchestrator assignment.

time_window_startstringoptional

Earliest time of day the vehicle is available.

time_window_endstringoptional

Latest time of day the vehicle is available.

return_to_depotbooleanoptional

Whether the vehicle should return to depot after assigned work.

fuel_volume_unitstringoptional

Unit for fuel volumes.

odometer_at_purchasenumberoptional

Odometer reading at the time of purchase.

transmissionstringoptional

Transmission type.

body_typestringoptional

Vehicle body type.

body_sub_typestringoptional

Vehicle body sub type.

usage_typestringoptional

How the vehicle is used.

ownership_typestringoptional

How the vehicle is held.

cargo_volumenumberoptional

Cargo volume.

passenger_volumenumberoptional

Passenger volume.

interior_volumenumberoptional

Total interior volume.

ground_clearancenumberoptional

Ground clearance.

bed_lengthnumberoptional

Bed length.

fuel_capacitynumberoptional

Fuel tank capacity.

emission_standardstringoptional

Emission standard the vehicle meets.

dpf_equippedbooleanoptional

Whether a diesel particulate filter is fitted.

scr_equippedbooleanoptional

Whether selective catalytic reduction is fitted.

gvwrnumberoptional

Gross vehicle weight rating.

gcwrnumberoptional

Gross combined weight rating.

engine_numberstringoptional

Engine number.

engine_makestringoptional

Engine manufacturer.

engine_modelstringoptional

Engine model.

engine_familystringoptional

Engine family.

engine_configurationstringoptional

Engine configuration.

engine_sizenumberoptional

Engine size.

engine_displacementnumberoptional

Engine displacement.

cylinder_arrangementstringoptional

Cylinder arrangement.

number_of_cylindersintegeroptional

Number of cylinders.

horsepowernumberoptional

Engine horsepower.

horsepower_rpmintegeroptional

RPM at which peak horsepower is produced.

torquenumberoptional

Engine torque.

torque_rpmintegeroptional

RPM at which peak torque is produced.

estimated_service_life_distanceintegeroptional

Estimated service life expressed as a distance.

estimated_service_life_distance_unitstringoptional

Unit for the estimated service life distance.

estimated_service_life_monthsintegeroptional

Estimated service life expressed in months.

financing_statusstringoptional

Vehicle financing status.

insurance_valuecurrencyoptional

Insured value.

depreciation_ratenumberoptional

Depreciation rate.

loan_amountnumberoptional

Loan principal.

loan_number_of_paymentsintegeroptional

Number of loan payments.

loan_first_paymentdateoptional

Date of the first loan payment.

The Vehicle object
{
  "id": "vehicle_7YqM3KpL2n",
  "internal_id": "VEH-1001",
  "photo_url": null,
  "avatar_url": null,
  "name": "ABC123",
  "description": null,
  "driver": null,
  "make": "Toyota",
  "model": "Camry",
  "year": 2023,
  "trim": "SE",
  "type": "sedan",
  "plate_number": "ABC123",
  "vin": "1GCGSBEA0G1111111",
  "status": "operational",
  "online": false,
  "payload_capacity": 500,
  "fuel_card_number": "FC-1001",
  "driver_id": null,
  "vendor_id": "vendor_5Nq8Tz1Wm4",
  "category_id": null,
  "warranty_id": null,
  "photo_id": null,
  "skills": [
    "tail_lift"
  ],
  "max_tasks": 40,
  "time_window_start": "08:00:00",
  "time_window_end": "18:00:00",
  "return_to_depot": true,
  "location": {
    "latitude": 40.7484,
    "longitude": -73.9857
  },
  "heading": 0,
  "altitude": 0,
  "speed": 0,
  "notes": null,
  "meta": {},
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
POST/v1/vehicles

Create a Vehicle

Creates a vehicle for the current organization.

Every safe business field the vehicle record holds is accepted: identity and description, odometer and measurement, body, capacity and dimensions, lifecycle and financing, regulatory and engine specifications, structured specs / details / meta, orchestrator constraints, and the vendor, driver, category and warranty relationships.

Relationships take public IDs (vendor_..., driver_..., category_..., warranty_...) and are resolved inside the authenticated organization; another organization's public ID is rejected exactly as a non-existent one is. Server-managed values — decoded vin_data, telematics, the generated slug, and every internal uuid column — are not accepted as input.

Body parameters
internal_idstringoptional

The identifier the operator's own system uses for this vehicle. Queryable through ?internal_id=.

namestringoptional

Vehicle display name.

descriptionstringoptional

Free-text description of the vehicle.

makestringoptional

Vehicle manufacturer.

modelstringoptional

Vehicle model.

model_typestringoptional

Vehicle model type or variant family.

yearintegeroptional

Model year of the vehicle.

trimstringoptional

Vehicle trim or variant.

colorstringoptional

Vehicle colour.

typestringoptional

Vehicle type.

classstringoptional

Vehicle class.

plate_numberstringoptional

Vehicle licence plate number. Queryable through ?plate_number=.

vinstringoptional

Vehicle identification number. Updating it re-runs VIN decoding. Queryable through ?vin=.

serial_numberstringoptional

Vehicle serial number.

call_signstringoptional

Vehicle call sign.

fuel_card_numberstringoptional

Fuel card number assigned to the vehicle.

odometernumberoptional

Current odometer reading. Must be zero or greater.

odometer_unitstringoptional

Unit for odometer readings, for example km or mi.

odometer_at_purchasenumberoptional

Odometer reading at the time of purchase.

measurement_systemstringoptional

Measurement system used for the vehicle's metrics, for example metric or imperial.

fuel_typestringoptional

Vehicle fuel type.

fuel_volume_unitstringoptional

Unit for fuel volumes, for example l or gal.

onlinebooleanoptionalDefault: false

Whether the vehicle is online. On create it defaults to false; on update it is left alone unless it is sent.

statusenumoptional

Vehicle operational status. active is accepted and stored as available. One of active, available, in_use, maintenance, out_of_service, reserved, retired, staging, on_route, idle, cleaning, awaiting_parts, inspection_due, inspection_failed, accident, compliance_hold, stolen, operational, decommissioned.

transmissionstringoptional

Transmission type.

body_typestringoptional

Vehicle body type.

body_sub_typestringoptional

Vehicle body sub type.

usage_typestringoptional

How the vehicle is used, for example commercial.

ownership_typestringoptional

How the vehicle is held, for example owned or leased.

cargo_volumenumberoptional

Cargo volume.

passenger_volumenumberoptional

Passenger volume.

interior_volumenumberoptional

Total interior volume.

weightnumberoptional

Vehicle weight.

widthnumberoptional

Vehicle width.

lengthnumberoptional

Vehicle length.

heightnumberoptional

Vehicle height.

towing_capacitynumberoptional

Towing capacity.

payload_capacitynumberoptional

Payload capacity.

seating_capacityintegeroptional

Seating capacity.

ground_clearancenumberoptional

Ground clearance.

bed_lengthnumberoptional

Bed length.

fuel_capacitynumberoptional

Fuel tank capacity.

financing_statusstringoptional

Vehicle financing status.

loan_number_of_paymentsintegeroptional

Number of loan payments.

loan_first_paymentdateoptional

Date of the first loan payment.

loan_amountnumberoptional

Loan principal.

estimated_service_life_distance_unitstringoptional

Unit for the estimated service life distance.

estimated_service_life_distanceintegeroptional

Estimated service life expressed as a distance.

estimated_service_life_monthsintegeroptional

Estimated service life expressed in months.

insurance_valuenumberoptional

Insured value.

depreciation_ratenumberoptional

Depreciation rate.

current_valuenumberoptional

Current vehicle value.

acquisition_costnumberoptional

Acquisition cost.

currencystringoptional

Three-letter currency code for the vehicle's monetary fields.

purchased_attimestampoptional

When the vehicle was purchased.

lease_expires_attimestampoptional

When the vehicle's lease expires.

emission_standardstringoptional

Emission standard the vehicle meets, for example euro6.

dpf_equippedbooleanoptional

Whether a diesel particulate filter is fitted.

scr_equippedbooleanoptional

Whether selective catalytic reduction is fitted.

gvwrnumberoptional

Gross vehicle weight rating.

gcwrnumberoptional

Gross combined weight rating.

engine_numberstringoptional

Engine number.

engine_modelstringoptional

Engine model.

engine_makestringoptional

Engine manufacturer.

engine_familystringoptional

Engine family.

engine_configurationstringoptional

Engine configuration.

engine_displacementnumberoptional

Engine displacement.

engine_sizenumberoptional

Engine size.

horsepowernumberoptional

Engine horsepower.

horsepower_rpmintegeroptional

RPM at which peak horsepower is produced.

torquenumberoptional

Engine torque.

torque_rpmintegeroptional

RPM at which peak torque is produced.

number_of_cylindersintegeroptional

Number of cylinders.

cylinder_arrangementstringoptional

Cylinder arrangement, for example I4 or V6.

specsobjectoptional

Structured vehicle specification data.

detailsobjectoptional

Structured additional vehicle detail data.

notesstringoptional

Free-text notes about the vehicle.

metaobjectoptional

Additional vehicle metadata.

skillsarray of stringsoptional

Capabilities the vehicle offers for orchestrator assignment, for example tail_lift.

payload_capacity_volumenumberoptional

Payload volume capacity used by orchestrator assignment.

payload_capacity_palletsintegeroptional

Pallet capacity used by orchestrator assignment.

payload_capacity_parcelsintegeroptional

Parcel capacity used by orchestrator assignment.

max_tasksintegeroptional

Maximum concurrent tasks for orchestrator assignment.

time_window_startstringoptional

Earliest time of day the vehicle is available, as HH:MM.

time_window_endstringoptional

Latest time of day the vehicle is available, as HH:MM.

return_to_depotbooleanoptional

Whether the vehicle should return to depot after assigned work.

vendorstringoptional

Vendor public ID (vendor_...). Send null to clear. Must belong to the authenticated organization.

driverstringoptional

Driver public ID (driver_...) to assign this vehicle to. Send an empty value to unassign the current driver. Must belong to the authenticated organization.

categorystringoptional

Category public ID (category_...). Send null to clear.

warrantystringoptional

Warranty public ID (warranty_...). Send null to clear.

photostringoptional

File public ID (file_...) to use as the vehicle photo.

locationobjectoptional

Resolvable point used as the vehicle's current location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

POST/v1/vehicles
curl -X POST https://api.fleetbase.io/v1/vehicles \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "internal_id": "VEH-1001",
  "name": "Depot Van",
  "description": "City route van",
  "vin": "1GCGSBEA0G1111111",
  "year": 2023,
  "make": "Toyota",
  "model": "Camry",
  "trim": "SE",
  "color": "White",
  "type": "sedan",
  "class": "N1",
  "plate_number": "ABC123",
  "serial_number": "SER-1001",
  "call_sign": "DEPOT-1",
  "fuel_card_number": "FC-1001",
  "status": "maintenance",
  "online": false,
  "odometer": 41000,
  "odometer_unit": "km",
  "odometer_at_purchase": 12,
  "measurement_system": "metric",
  "fuel_type": "diesel",
  "fuel_volume_unit": "l",
  "transmission": "automatic",
  "body_type": "sedan",
  "seating_capacity": 5,
  "weight": 1620.5,
  "payload_capacity": 1400,
  "fuel_capacity": 60,
  "currency": "SGD",
  "purchased_at": "2026-01-02",
  "loan_first_payment": "2026-02-15",
  "loan_amount": 32000,
  "insurance_value": 41000,
  "depreciation_rate": 12.5,
  "current_value": 38000,
  "acquisition_cost": 52000,
  "engine_number": "ENG-1001",
  "number_of_cylinders": 4,
  "latitude": 40.7484,
  "longitude": -73.9857,
  "specs": { "doors": 4 },
  "details": { "liftgate": true },
  "notes": "City route pool",
  "meta": { "depot": "north" },
  "skills": ["tail_lift"],
  "max_tasks": 40,
  "time_window_start": "08:00",
  "time_window_end": "18:00",
  "return_to_depot": true,
  "vendor": "{{vendor_id}}"
}'
Other ways to call this
201 OK
{
  "id": "vehicle_7YqM3KpL2n",
  "internal_id": "VEH-1001",
  "name": "Depot Van",
  "vin": "1GCGSBEA0G1111111",
  "photo_url": "https://s3.ap-southeast-1.amazonaws.com/flb-assets/static/vehicle-placeholder.png",
  "make": "Toyota",
  "model": "Camry",
  "year": "2023",
  "trim": "SE",
  "type": "sedan",
  "plate_number": "ABC123",
  "status": "maintenance",
  "online": false,
  "odometer": 41000,
  "odometer_unit": "km",
  "skills": [
    "tail_lift"
  ],
  "max_tasks": null,
  "time_window_start": null,
  "time_window_end": null,
  "return_to_depot": true,
  "driver_id": null,
  "vendor_id": "vendor_5Nq8Tz1Wm4",
  "category_id": null,
  "warranty_id": null,
  "photo_id": null,
  "meta": {
    "depot": "north"
  },
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
GET/v1/vehicles

Query Vehicles

This endpoint allows you to query vehicles you have created, it also provides paginated results on all the vehicles in your Fleetbase.

Query parameters
querystringoptional

Free-text search across the vehicle's searchable fields.

internal_idstringoptional

Filter by the identifier the operator's own system uses. Exact match on the public API: VEH-10 returns only VEH-10, never VEH-100. That is what lets an importer use it to decide between update and create. (The Fleet-Ops console does a partial search on the same field; that behaviour is internal to the console and not part of this contract.)

plate_numberstringoptional

Filter by licence plate number.

vinstringoptional

Filter by vehicle identification number.

public_idstringoptional

Filter by vehicle public ID (vehicle_...). Exact match.

display_namestringoptional

Filter across year, make, model and plate number together.

vehicle_makestringoptional

Filter by manufacturer.

vehicle_modelstringoptional

Filter by model.

vehicle_yearstringoptional

Filter by model year.

vendorstringoptional

Filter by vendor, given as its public ID (vendor_...) or internal ID.

driverstringoptional

Filter by assigned driver, given as its public ID (driver_...) or internal ID. Pass unassigned to return vehicles with no driver.

fleetstringoptional

Filter to the vehicles in a fleet, given as its public ID (fleet_...).

assigned_fleetstringoptional

Pass false to return vehicles that belong to no fleet.

limitintegeroptional

Maximum number of vehicles to return.

offsetintegeroptional

Number of vehicles to skip before returning results.

sortstringoptional

Sort expression for the vehicle query.

witharray of stringsoptional

Relationships to expand. Accepted as ?with=vendor, ?with[]=vendor, ?with[]=vendor&with[]=driver and ?with=vendor,driver; expand is an alias for all four. A relationship named here is additionally returned as a nested object — it never replaces or retypes the <name>_id identifier, which is always present. A name outside the supported set is ignored rather than rejected.

GET/v1/vehicles
curl https://api.fleetbase.io/v1/vehicles?query={{vehicle_name}}&limit=25&offset=0&sort=created_at \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
[
  {
    "id": "vehicle_7YqM3KpL2n",
    "internal_id": "VEH-1001",
    "name": "Depot Van",
    "vin": "1GCGSBEA0G1111111",
    "photo_url": "https://s3.ap-southeast-1.amazonaws.com/flb-assets/static/vehicle-placeholder.png",
    "avatar_url": "https://flb-assets.s3-ap-southeast-1.amazonaws.com/static/vehicle-icons/mini_bus.svg",
    "make": "Toyota",
    "model": "Camry",
    "year": "2023",
    "trim": "SE",
    "type": "sedan",
    "plate_number": "ABC123",
    "fuel_card_number": "FC-1001",
    "status": "available",
    "online": false,
    "odometer": 41000,
    "odometer_unit": "km",
    "currency": "SGD",
    "purchased_at": "2026-01-02T00:00:00.000000Z",
    "location": {
      "type": "Point",
      "coordinates": [
        -73.9857,
        40.7484
      ]
    },
    "driver_id": null,
    "vendor_id": "vendor_5Nq8Tz1Wm4",
    "category_id": null,
    "warranty_id": null,
    "photo_id": null,
    "specs": {
      "doors": 4
    },
    "details": {
      "liftgate": true
    },
    "notes": "City route pool",
    "meta": {
      "depot": "north"
    },
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  }
]
GET/v1/vehicles/:id

Retrieve a Vehicle

Retrieve details for a specific Vehicle.

GET/v1/vehicles/:id
curl https://api.fleetbase.io/v1/vehicles/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "id": "vehicle_7YqM3KpL2n",
  "internal_id": "VEH-1001",
  "name": "Depot Van",
  "vin": "1GCGSBEA0G1111111",
  "photo_url": "https://s3.ap-southeast-1.amazonaws.com/flb-assets/static/vehicle-placeholder.png",
  "avatar_url": "https://flb-assets.s3-ap-southeast-1.amazonaws.com/static/vehicle-icons/mini_bus.svg",
  "make": "Toyota",
  "model": "Camry",
  "year": "2023",
  "trim": "SE",
  "type": "sedan",
  "plate_number": "ABC123",
  "fuel_card_number": "FC-1001",
  "status": "available",
  "online": false,
  "odometer": 41000,
  "odometer_unit": "km",
  "currency": "SGD",
  "purchased_at": "2026-01-02T00:00:00.000000Z",
  "location": {
    "type": "Point",
    "coordinates": [
      -73.9857,
      40.7484
    ]
  },
  "driver_id": null,
  "vendor_id": "vendor_5Nq8Tz1Wm4",
  "category_id": null,
  "warranty_id": null,
  "photo_id": null,
  "specs": {
    "doors": 4
  },
  "details": {
    "liftgate": true
  },
  "notes": "City route pool",
  "meta": {
    "depot": "north"
  },
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
GET/v1/vehicles/:id?with[]=vendor&with[]=not_a_relation

Expand a Vehicle

Retrieves a vehicle with its vendor expanded, using the array form of the expansion parameter.

Both ?with=vendor and ?with[]=vendor are accepted, as are ?with=vendor,driver and the expand alias. Expansion is strictly additive: it adds the nested object and leaves vendor_id exactly as it was. A relationship name outside the supported set is ignored rather than rejected, so a client sending a relation this version does not have still gets its response.

GET/v1/vehicles/:id?with[]=vendor&with[]=not_a_relation
curl https://api.fleetbase.io/v1/vehicles/:id?with[]=vendor&with[]=not_a_relation \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "id": "vehicle_7YqM3KpL2n",
  "internal_id": "VEH-1001",
  "name": "Depot Van",
  "vin": "1GCGSBEA0G1111111",
  "photo_url": "https://s3.ap-southeast-1.amazonaws.com/flb-assets/static/vehicle-placeholder.png",
  "avatar_url": "https://flb-assets.s3-ap-southeast-1.amazonaws.com/static/vehicle-icons/mini_bus.svg",
  "make": "Toyota",
  "model": "Camry",
  "year": "2023",
  "trim": "SE",
  "type": "sedan",
  "plate_number": "ABC123",
  "fuel_card_number": "FC-1001",
  "status": "available",
  "online": false,
  "odometer": 41000,
  "odometer_unit": "km",
  "currency": "SGD",
  "purchased_at": "2026-01-02T00:00:00.000000Z",
  "location": {
    "type": "Point",
    "coordinates": [
      -73.9857,
      40.7484
    ]
  },
  "driver_id": null,
  "vendor_id": "vendor_5Nq8Tz1Wm4",
  "vendor": {
    "id": "vendor_5Nq8Tz1Wm4",
    "name": "Acme Logistics"
  },
  "category_id": null,
  "warranty_id": null,
  "photo_id": null,
  "specs": {
    "doors": 4
  },
  "details": {
    "liftgate": true
  },
  "notes": "City route pool",
  "meta": {
    "depot": "north"
  },
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
GET/v1/vehicles/:id?with=vendor

Expand a Vehicle Scalar

The same expansion as Expand a Vehicle, sent in the scalar comma-separated form.

?with=vendor,driver must behave exactly as ?with[]=vendor&with[]=driver does. This request exists so the two spellings are proven equivalent rather than assumed to be.

GET/v1/vehicles/:id?with=vendor
curl https://api.fleetbase.io/v1/vehicles/:id?with=vendor?with=vendor \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
PUT/v1/vehicles/:id

Update a Vehicle

Updates any safe vehicle field. Updating the VIN re-runs VIN decoding.

A partial update touches only the fields that are sent: omitting online leaves the vehicle's online state alone rather than taking it offline. Relationship inputs take public IDs and are resolved inside the authenticated organization; sending null clears the assignment, and sending an empty driver unassigns the current driver.

Body parameters
internal_idstringoptional

The identifier the operator's own system uses for this vehicle. Queryable through ?internal_id=.

namestringoptional

Vehicle display name.

descriptionstringoptional

Free-text description of the vehicle.

makestringoptional

Vehicle manufacturer.

modelstringoptional

Vehicle model.

model_typestringoptional

Vehicle model type or variant family.

yearintegeroptional

Model year of the vehicle.

trimstringoptional

Vehicle trim or variant.

colorstringoptional

Vehicle colour.

typestringoptional

Vehicle type.

classstringoptional

Vehicle class.

plate_numberstringoptional

Vehicle licence plate number. Queryable through ?plate_number=.

vinstringoptional

Vehicle identification number. Updating it re-runs VIN decoding. Queryable through ?vin=.

serial_numberstringoptional

Vehicle serial number.

call_signstringoptional

Vehicle call sign.

fuel_card_numberstringoptional

Fuel card number assigned to the vehicle.

odometernumberoptional

Current odometer reading. Must be zero or greater.

odometer_unitstringoptional

Unit for odometer readings, for example km or mi.

odometer_at_purchasenumberoptional

Odometer reading at the time of purchase.

measurement_systemstringoptional

Measurement system used for the vehicle's metrics, for example metric or imperial.

fuel_typestringoptional

Vehicle fuel type.

fuel_volume_unitstringoptional

Unit for fuel volumes, for example l or gal.

onlinebooleanoptionalDefault: false

Whether the vehicle is online. On create it defaults to false; on update it is left alone unless it is sent.

statusenumoptional

Vehicle operational status. active is accepted and stored as available. One of active, available, in_use, maintenance, out_of_service, reserved, retired, staging, on_route, idle, cleaning, awaiting_parts, inspection_due, inspection_failed, accident, compliance_hold, stolen, operational, decommissioned.

transmissionstringoptional

Transmission type.

body_typestringoptional

Vehicle body type.

body_sub_typestringoptional

Vehicle body sub type.

usage_typestringoptional

How the vehicle is used, for example commercial.

ownership_typestringoptional

How the vehicle is held, for example owned or leased.

cargo_volumenumberoptional

Cargo volume.

passenger_volumenumberoptional

Passenger volume.

interior_volumenumberoptional

Total interior volume.

weightnumberoptional

Vehicle weight.

widthnumberoptional

Vehicle width.

lengthnumberoptional

Vehicle length.

heightnumberoptional

Vehicle height.

towing_capacitynumberoptional

Towing capacity.

payload_capacitynumberoptional

Payload capacity.

seating_capacityintegeroptional

Seating capacity.

ground_clearancenumberoptional

Ground clearance.

bed_lengthnumberoptional

Bed length.

fuel_capacitynumberoptional

Fuel tank capacity.

financing_statusstringoptional

Vehicle financing status.

loan_number_of_paymentsintegeroptional

Number of loan payments.

loan_first_paymentdateoptional

Date of the first loan payment.

loan_amountnumberoptional

Loan principal.

estimated_service_life_distance_unitstringoptional

Unit for the estimated service life distance.

estimated_service_life_distanceintegeroptional

Estimated service life expressed as a distance.

estimated_service_life_monthsintegeroptional

Estimated service life expressed in months.

insurance_valuenumberoptional

Insured value.

depreciation_ratenumberoptional

Depreciation rate.

current_valuenumberoptional

Current vehicle value.

acquisition_costnumberoptional

Acquisition cost.

currencystringoptional

Three-letter currency code for the vehicle's monetary fields.

purchased_attimestampoptional

When the vehicle was purchased.

lease_expires_attimestampoptional

When the vehicle's lease expires.

emission_standardstringoptional

Emission standard the vehicle meets, for example euro6.

dpf_equippedbooleanoptional

Whether a diesel particulate filter is fitted.

scr_equippedbooleanoptional

Whether selective catalytic reduction is fitted.

gvwrnumberoptional

Gross vehicle weight rating.

gcwrnumberoptional

Gross combined weight rating.

engine_numberstringoptional

Engine number.

engine_modelstringoptional

Engine model.

engine_makestringoptional

Engine manufacturer.

engine_familystringoptional

Engine family.

engine_configurationstringoptional

Engine configuration.

engine_displacementnumberoptional

Engine displacement.

engine_sizenumberoptional

Engine size.

horsepowernumberoptional

Engine horsepower.

horsepower_rpmintegeroptional

RPM at which peak horsepower is produced.

torquenumberoptional

Engine torque.

torque_rpmintegeroptional

RPM at which peak torque is produced.

number_of_cylindersintegeroptional

Number of cylinders.

cylinder_arrangementstringoptional

Cylinder arrangement, for example I4 or V6.

specsobjectoptional

Structured vehicle specification data.

detailsobjectoptional

Structured additional vehicle detail data.

notesstringoptional

Free-text notes about the vehicle.

metaobjectoptional

Additional vehicle metadata.

skillsarray of stringsoptional

Capabilities the vehicle offers for orchestrator assignment, for example tail_lift.

payload_capacity_volumenumberoptional

Payload volume capacity used by orchestrator assignment.

payload_capacity_palletsintegeroptional

Pallet capacity used by orchestrator assignment.

payload_capacity_parcelsintegeroptional

Parcel capacity used by orchestrator assignment.

max_tasksintegeroptional

Maximum concurrent tasks for orchestrator assignment.

time_window_startstringoptional

Earliest time of day the vehicle is available, as HH:MM.

time_window_endstringoptional

Latest time of day the vehicle is available, as HH:MM.

return_to_depotbooleanoptional

Whether the vehicle should return to depot after assigned work.

vendorstringoptional

Vendor public ID (vendor_...). Send null to clear. Must belong to the authenticated organization.

driverstringoptional

Driver public ID (driver_...) to assign this vehicle to. Send an empty value to unassign the current driver. Must belong to the authenticated organization.

categorystringoptional

Category public ID (category_...). Send null to clear.

warrantystringoptional

Warranty public ID (warranty_...). Send null to clear.

photostringoptional

File public ID (file_...) to use as the vehicle photo.

locationobjectoptional

Resolvable point used as the vehicle's current location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

PUT/v1/vehicles/:id
curl -X PUT https://api.fleetbase.io/v1/vehicles/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "plate_number": "ABC123",
    "status": "operational",
    "odometer": 41250,
    "color": "Silver",
    "body_type": "sedan",
    "transmission": "automatic",
    "seating_capacity": 5,
    "currency": "SGD",
    "purchased_at": "2026-01-02",
    "specs": { "doors": 4 },
    "details": { "liftgate": true },
    "meta": { "depot": "south" },
    "latitude": 40.7484,
    "longitude": -73.9857,
    "speed": 90
}'
Other ways to call this
200 OK
{
  "id": "vehicle_7YqM3KpL2n",
  "internal_id": "VEH-1001",
  "name": "Depot Van",
  "make": "Toyota",
  "model": "Camry",
  "year": "2023",
  "plate_number": "ABC123",
  "color": "Silver",
  "status": "operational",
  "online": false,
  "odometer": 41250,
  "odometer_unit": "km",
  "specs": {
    "doors": 4
  },
  "meta": {
    "depot": "south"
  },
  "vendor_id": "vendor_5Nq8Tz1Wm4",
  "updated_at": "2026-05-07T09:12:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
DELETE/v1/vehicles/:id

Delete a Vehicle

Permanently deletes a Vehicle. It cannot be undone.

DELETE/v1/vehicles/:id
curl -X DELETE https://api.fleetbase.io/v1/vehicles/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "deleted": "<boolean>",
  "id": "<string>"
}
PATCH/v1/vehicles/:id/track

Track Vehicle

Body parameters
latitudenumberoptional

Vehicle latitude. When omitted with longitude, Fleetbase returns the current vehicle resource without updating location.

longitudenumberoptional

Vehicle longitude. When omitted with latitude, Fleetbase returns the current vehicle resource without updating location.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

PATCH/v1/vehicles/:id/track
curl -X PATCH https://api.fleetbase.io/v1/vehicles/:id/track \
  -H "Authorization: Bearer flb_live_…"
Vehicles | Fleetbase