Drivers

Drivers are mobile workers who can be assigned to vehicles and orders. Use driver endpoints to manage driver profiles, authentication, devices, availability, tracking, and organization context.

The Driver object

A driver represents a FleetOps operator who can receive jobs, report location, register devices, and belong to fleets, vendors, vehicles, and organizations.

Attributes

idstringoptional

Public driver identifier.

userstringoptional

Public user ID linked to the driver.

internal_idstringoptional

Optional internal identifier.

companystringoptional

Public company ID for the driver's current company.

company_namestringoptional

Name of the driver's current company.

namestringoptional

Driver display name.

emailstringoptional

Driver email address.

phonestringoptional

Driver phone number.

drivers_license_numberstringoptional

Driver license number.

photo_urlstringoptional

Driver photo URL.

avatar_urlstringoptional

Driver avatar URL.

vehicleobjectoptional

Assigned vehicle, when loaded.

current_jobobjectoptional

Current order, when loaded.

vendorobjectoptional

Assigned vendor, when loaded.

fleetsarray of objectsoptional

Fleets the driver belongs to, when loaded.

locationobjectoptional

Current driver coordinates.

headingintegeroptional

Current heading in degrees.

altitudeintegeroptional

Current altitude.

speedintegeroptional

Current speed.

countrystringoptional

Current country code.

currencycurrencyoptional

Currency inferred from the driver's country.

citystringoptional

Current city.

onlinebooleanoptional

Whether the driver is online.

statusstringoptional

Driver lifecycle status.

tokenstringoptional

Authentication token returned by driver login endpoints.

metaobjectoptional

Additional driver metadata.

updated_attimestampoptional

Timestamp when the driver was last updated.

created_attimestampoptional

Timestamp when the driver was created.

The Driver object

{
  "id": "driver_A1b2C3d4E5",
  "user": "user_1A2b3C4d5E",
  "internal_id": "DRV-1001",
  "company": "company_6zV1KqN9pR",
  "company_name": "Fleetbase",
  "name": "Alex Driver",
  "email": "alex.driver@example.com",
  "phone": "+15555550111",
  "drivers_license_number": null,
  "photo_url": null,
  "avatar_url": null,
  "vehicle_avatar": null,
  "location": {
    "latitude": 1.3521,
    "longitude": 103.8198
  },
  "heading": 0,
  "altitude": 0,
  "speed": 0,
  "country": "SG",
  "currency": "SGD",
  "city": "Singapore",
  "online": false,
  "status": "active",
  "token": null,
  "meta": {},
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/drivers

Create a Driver

Creates a driver profile and linked user account. Provide a unique email and phone number, then optionally assign a vehicle, vendor, current job, location, or photo.

Body parameters

namestringrequired

Driver display name.

emailstringrequired

Driver email address. Must be unique when creating a driver.

phonestringrequired

Driver phone number. Must be unique when creating a driver.

passwordstringoptional

Optional password for the driver user account.

timezonestringoptional

Timezone for the driver user account.

countrystringoptional

Two-letter country code.

citystringoptional

Driver city.

vehiclestringoptional

Vehicle ID to assign to the driver.

vendorstringoptional

Vendor ID to assign to the driver.

jobstringoptional

Current order ID to assign to the driver.

statusenumoptional

Driver lifecycle status. One of active, inactive.

photostringoptional

File ID, upload reference, or resolvable file input for the driver photo.

locationobjectoptional

Resolvable point used as the driver's current location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

metaobjectoptional

Additional driver metadata.

POST/v1/drivers

curl -X POST https://api.fleetbase.io/v1/drivers \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "name": "John Doe",
  "email": "{{$randomEmail}}",
  "phone": "{{$randomPhoneNumber}}"
}'

200 OK

{
  "id": "<string>",
  "current_job": "<string>",
  "vehicle": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "signup_token_used": "<string>",
  "drivers_license_number": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "heading": "<string>",
  "altitude": "<string>",
  "speed": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "city": "<string>",
  "online": "<number>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/drivers

Query Drivers

Returns drivers for the current company. Use filters such as vendor, search, pagination, or sort parameters to narrow the result set.

Query parameters

idstringoptional

Driver ID filter used by this request example.

querystringoptional

Search term matched against driver fields.

limitintegeroptional

Maximum number of drivers to return.

offsetintegeroptional

Number of drivers to skip before returning results.

sortstringoptional

Sort expression for the driver query.

vendorstringoptional

Vendor ID used to filter drivers assigned to a vendor.

GET/v1/drivers

curl https://api.fleetbase.io/v1/drivers?id={{driver_id}} \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "current_job": "<string>",
  "vehicle": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "signup_token_used": "<string>",
  "drivers_license_number": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "heading": "<string>",
  "altitude": "<string>",
  "speed": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "city": "<string>",
  "online": "<number>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/drivers/:id

Retrieve a Driver

This endpoint allows you to retrieve a driver object to view it's details.

GET/v1/drivers/:id

curl https://api.fleetbase.io/v1/drivers/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "current_job": "<string>",
  "vehicle": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "signup_token_used": "<string>",
  "drivers_license_number": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "heading": "<string>",
  "altitude": "<string>",
  "speed": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "city": "<string>",
  "online": "<number>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

PUT/v1/drivers/:id

Update a Driver

Updates a driver's account fields, assignment, status, location, photo, or metadata.

Body parameters

namestringoptional

Driver display name.

emailstringoptional

Driver email address.

phonestringoptional

Driver phone number.

passwordstringoptional

Optional password for the driver user account.

vehiclestringoptional

Vehicle ID to assign to the driver.

vendorstringoptional

Vendor ID to assign to the driver.

jobstringoptional

Current order ID to assign to the driver.

statusenumoptional

Driver lifecycle status. One of active, inactive.

photostringoptional

File ID, upload reference, or resolvable file input for the driver photo.

locationobjectoptional

Resolvable point used as the driver's current location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

metaobjectoptional

Additional driver metadata.

PUT/v1/drivers/:id

curl -X PUT https://api.fleetbase.io/v1/drivers/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "name": "John Doe",
  "email": "{{$randomEmail}}",
  "phone": "{{$randomPhoneNumber}}"
}'

200 OK

{
  "id": "<string>",
  "current_job": "<string>",
  "vehicle": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "signup_token_used": "<string>",
  "drivers_license_number": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "heading": "<string>",
  "altitude": "<string>",
  "speed": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "city": "<string>",
  "online": "<number>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

DELETE/v1/drivers/:id

Delete a Driver

Use this endpoint to delete a driver.

DELETE/v1/drivers/:id

curl -X DELETE https://api.fleetbase.io/v1/drivers/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "deleted": "<boolean>",
  "id": "<string>"
}

PATCH/v1/drivers/:id/track

Track Driver

Body parameters

latitudenumberoptional

Driver latitude. When omitted with longitude, Fleetbase returns the current driver resource without updating location.

longitudenumberoptional

Driver longitude. When omitted with latitude, Fleetbase returns the current driver resource without updating location.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

PATCH/v1/drivers/:id/track

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

POST/v1/drivers/login

Login Driver

Authenticates a driver with email/phone and password.

Body parameters

identitystringrequired

Driver email address or phone number.

passwordstringrequired

Driver account password.

POST/v1/drivers/login

curl -X POST https://api.fleetbase.io/v1/drivers/login \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "identity": "{{driver_identity}}",
  "password": "{{driver_password}}"
}'

POST/v1/drivers/login-with-sms

Request Driver Login SMS

Starts driver SMS verification login.

Body parameters

phonestringrequired

Driver phone number to send the verification code to.

POST/v1/drivers/login-with-sms

curl -X POST https://api.fleetbase.io/v1/drivers/login-with-sms \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "{{driver_phone}}"
}'

POST/v1/drivers/verify-code

Verify Driver Login Code

Verifies driver login code and returns a driver token.

Body parameters

identitystringrequired

Driver email address or phone number used for verification.

codestringrequired

Verification code sent to the driver.

forstringoptionalDefault: driver_login

Verification purpose. Defaults to driver_login.

POST/v1/drivers/verify-code

curl -X POST https://api.fleetbase.io/v1/drivers/verify-code \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "identity": "{{driver_identity}}",
  "code": "{{verification_code}}"
}'

POST/v1/drivers/:id/register-device

Register Driver Device

Registers a device token for a specific driver.

Body parameters

tokenstringrequired

Device push token to register for the driver.

platformstringrequired

Device platform. May also be supplied as os.

osstringoptional

Alias for platform.

POST/v1/drivers/:id/register-device

curl -X POST https://api.fleetbase.io/v1/drivers/:id/register-device \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "{{device_token}}",
  "platform": "ios"
}'

POST/v1/drivers/register-device

Register Device

Registers a driver device token through the non-id route.

Body parameters

tokenstringrequired

Device push token to register.

platformstringrequired

Device platform. May also be supplied as os.

osstringoptional

Alias for platform.

POST/v1/drivers/register-device

curl -X POST https://api.fleetbase.io/v1/drivers/register-device \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "{{device_token}}",
  "platform": "ios"
}'

POST/v1/drivers/:id/switch-organization

Switch Driver Organization

Switches the driver session to another organization.

Body parameters

nextstringrequired

Organization ID to switch the driver session to.

POST/v1/drivers/:id/switch-organization

curl -X POST https://api.fleetbase.io/v1/drivers/:id/switch-organization \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "next": "{{organization_id}}"
}'

POST/v1/drivers/:id/toggle-online

Toggle Driver Online

Toggles or sets driver online status.

Body parameters

onlinebooleanoptional

Online status to set. When omitted, Fleetbase toggles the driver's current online status.

POST/v1/drivers/:id/toggle-online

curl -X POST https://api.fleetbase.io/v1/drivers/:id/toggle-online \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "online": true
}'

GET/v1/drivers/:id/organizations

List Driver Organizations

Lists organizations a driver belongs to.

GET/v1/drivers/:id/organizations

curl https://api.fleetbase.io/v1/drivers/:id/organizations \
  -H "Authorization: Bearer flb_live_…"

GET/v1/drivers/:id/current-organization

Get Driver Current Organization

Returns the driver current organization.

GET/v1/drivers/:id/current-organization

curl https://api.fleetbase.io/v1/drivers/:id/current-organization \
  -H "Authorization: Bearer flb_live_…"

POST/v1/drivers/:id/simulate

Simulate Driver Route

Simulates driver movement between two resolvable points, or pass order to simulate an order route.

Body parameters

startobjectoptional

Starting point for the simulated drive. Required when order is not supplied.

endobjectoptional

Ending point for the simulated drive. Required when order is not supplied.

orderstringoptional

Order ID to simulate. Required when the action is order.

actionstringoptionalDefault: drive

Simulation action. Defaults to drive.

POST/v1/drivers/:id/simulate

curl -X POST https://api.fleetbase.io/v1/drivers/:id/simulate \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "start": {
    "latitude": 1.3521,
    "longitude": 103.8198
  },
  "end": {
    "latitude": 1.2903,
    "longitude": 103.8519
  }
}'