FleetbaseFleetbase
Start Free Trial

Fleets

Fleets group vehicles and drivers under an operating unit. Use fleets to organize capacity by team, region, or service area before assigning resources to orders.

The Fleet object

A fleet groups drivers and vehicles for operational assignment. Fleets can be linked to service areas, zones, vendors, parent fleets, subfleets, drivers, and vehicles.
Attributes
idstringoptional

Public fleet identifier.

namestringoptional

Fleet display name.

taskstringoptional

Task associated with the fleet.

statusstringoptional

Fleet status.

service_areaobjectoptional

Service area assigned to the fleet, when loaded.

zoneobjectoptional

Zone assigned to the fleet, when loaded.

vendorobjectoptional

Vendor assigned to the fleet, when loaded.

parent_fleetobjectoptional

Parent fleet, when loaded.

subfleetsarray of objectsoptional

Child fleets, when loaded.

driversarray of objectsoptional

Drivers assigned to the fleet, when loaded.

vehiclesarray of objectsoptional

Vehicles assigned to the fleet, when loaded.

updated_attimestampoptional

Timestamp when the fleet was last updated.

created_attimestampoptional

Timestamp when the fleet was created.

The Fleet object
{
  "id": "fleet_4Mnp8Qx2Vz",
  "name": "Haulers",
  "task": null,
  "status": "active",
  "service_area": null,
  "zone": null,
  "vendor": null,
  "parent_fleet": null,
  "subfleets": [],
  "drivers": [],
  "vehicles": [],
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
POST/v1/fleets

Create a Fleet

Creates a fleet for grouping drivers and vehicles. Assign a service area when the fleet should be constrained to a specific operating area.

Body parameters
namestringrequired

Fleet display name.

service_areastringoptional

Service area ID to assign to the fleet.

POST/v1/fleets
curl -X POST https://api.fleetbase.io/v1/fleets \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Haulers",
    "service_area": "{{service_area_id}}"
}'
200 OK
{
  "id": "<string>",
  "service_area": "<string>",
  "name": "<string>",
  "task": "<string>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}
GET/v1/fleets

Query Fleets

Returns a paginated list of fleets for the current organization. Use pagination and sorting parameters to control the result set.

Query parameters
limitintegeroptional

Maximum number of fleets to return.

offsetintegeroptional

Number of fleets to skip before returning results.

sortstringoptional

Sort expression for the fleet query.

witharray of stringsoptional

Relationships to include in fleet responses.

GET/v1/fleets
curl https://api.fleetbase.io/v1/fleets?limit=25&offset=0&sort=created_at \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "id": "<string>",
  "service_area": "<string>",
  "name": "<string>",
  "task": "<string>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}
GET/v1/fleets/:id

Retrieve a Fleet

Retrieves a fleet.

GET/v1/fleets/:id
curl https://api.fleetbase.io/v1/fleets/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "id": "<string>",
  "service_area": "<string>",
  "name": "<string>",
  "task": "<string>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}
PUT/v1/fleets/:id

Update a Fleet

Updates a fleet's name or assigned service area.

Body parameters
namestringoptional

Fleet display name.

service_areastringoptional

Service area ID to assign to the fleet.

PUT/v1/fleets/:id
curl -X PUT https://api.fleetbase.io/v1/fleets/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Haulers",
    "service_area": "{{service_area_id}}"
}'
200 OK
{
  "id": "<string>",
  "service_area": "<string>",
  "name": "<string>",
  "task": "<string>",
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}
DELETE/v1/fleets/:id

Delete a Fleet

Deletes a fleet.

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