Equipment
The Equipment object
idstringoptionalPublic equipment identifier.
namestringoptionalEquipment name.
codestringoptionalInternal equipment code.
typestringoptionalEquipment type.
statusstringoptionalEquipment availability status.
serial_numberstringoptionalEquipment serial number.
manufacturerstringoptionalEquipment manufacturer.
modelstringoptionalEquipment model.
equipablestringoptionalPublic ID of the assigned resource, when loaded.
equipable_typestringoptionalPublic attachment type such as fleet-ops:vehicle or fleet-ops:trailer.
equipable_idstringoptionalPublic ID of the attached Vehicle or Trailer.
equipable_namestringoptionalDisplay name of the attached Vehicle or Trailer.
metaobjectoptionalAdditional equipment metadata.
{
"id": "equipment_4Mnp8Qx2Vz",
"name": "Liftgate LG-12",
"code": "LG-12",
"type": "liftgate",
"status": "available",
"serial_number": "LG120045",
"manufacturer": "Maxon",
"model": "BMR",
"currency": "USD",
"is_equipped": false,
"meta": {},
"updated_at": "2026-05-07T08:30:00.000000Z",
"created_at": "2026-05-07T08:30:00.000000Z"
}/v1/equipmentCreate Equipment
Create equipment.
namestringoptionalEquipment name.
codestringoptionalInternal equipment code.
typestringoptionalEquipment type.
statusstringoptionalEquipment status.
warrantystringoptionalWarranty public ID.
photostringoptionalFile public ID for the equipment photo.
equipable_typestringoptionalPolymorphic resource type such as fleet-ops:vehicle, fleet-ops:trailer, or the existing fleet-ops:driver compatibility type.
equipablestringoptionalPublic ID of the resource to assign equipment to.
metaobjectoptionalAdditional metadata.
/v1/equipmentcurl -X POST https://api.fleetbase.io/v1/equipment \
-H "Authorization: Bearer flb_live_…" \
-H "Content-Type: application/json" \
-d '{
"name": "Liftgate LG-12",
"code": "LG-12",
"type": "liftgate",
"status": "available",
"serial_number": "LG120045",
"manufacturer": "Maxon",
"model": "BMR",
"currency": "USD"
}'{
"id": "<string>",
"object": "equipment"
}/v1/equipmentQuery Equipment
Query equipment.
querystringoptionalSearch query for equipment.
limitintegeroptionalMaximum number of records to return.
pageintegeroptionalPage number for paginated results.
sortstringoptionalSort expression, such as -created_at.
typestringoptionalFilter by equipment type.
statusstringoptionalFilter by equipment status.
manufacturerstringoptionalFilter by manufacturer.
/v1/equipmentcurl https://api.fleetbase.io/v1/equipment \
-H "Authorization: Bearer flb_live_…"{
"id": "<string>",
"object": "equipment"
}/v1/equipmentRetrieve Equipment
Retrieve equipment.
/v1/equipmentcurl https://api.fleetbase.io/v1/equipment \
-H "Authorization: Bearer flb_live_…"{
"id": "<string>",
"object": "equipment"
}/v1/equipmentUpdate Equipment
Update equipment.
namestringoptionalEquipment name.
codestringoptionalInternal equipment code.
typestringoptionalEquipment type.
statusstringoptionalEquipment status.
warrantystringoptionalWarranty public ID.
photostringoptionalFile public ID for the equipment photo.
equipable_typestringoptionalPolymorphic resource type such as fleet-ops:vehicle, fleet-ops:trailer, or the existing fleet-ops:driver compatibility type.
equipablestringoptionalPublic ID of the resource to assign equipment to.
metaobjectoptionalAdditional metadata.
/v1/equipmentcurl -X PUT https://api.fleetbase.io/v1/equipment \
-H "Authorization: Bearer flb_live_…" \
-H "Content-Type: application/json" \
-d '{
"status": "maintenance"
}'{
"id": "<string>",
"object": "equipment"
}/v1/equipmentDelete Equipment
Delete equipment.
/v1/equipmentcurl -X DELETE https://api.fleetbase.io/v1/equipment \
-H "Authorization: Bearer flb_live_…"{
"id": "<string>",
"deleted": true
}/v1/equipment/:id/attachAttach Equipment
Attach or atomically reassign Equipment to a Vehicle or Trailer.
attachable_typeenumoptionalAllowed target resource type. One of fleet-ops:vehicle, fleet-ops:trailer.
attachablestringoptionalVehicle or Trailer public ID.
/v1/equipment/:id/attachcurl -X POST https://api.fleetbase.io/v1/equipment/:id/attach \
-H "Authorization: Bearer flb_live_…" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"attachable_type":"fleet-ops:vehicle","attachable":"{{vehicle_id}}"}'/v1/equipment/:id/detachDetach Equipment
Detach Equipment from its current Vehicle or Trailer.
/v1/equipment/:id/detachcurl -X POST https://api.fleetbase.io/v1/equipment/:id/detach \
-H "Authorization: Bearer flb_live_…" \
-H "Accept: application/json"