List Driver Availability
Query Parameters
Page number for pagination
Number of items per page
Filter by driver UUID
Filter by online status
Filter by trip availability
Response
Indicates if the operation was successful
Response message
Array of driver availability records
Pagination metadata
Create Driver Availability
Body Parameters
UUID of the driver
Whether the driver is currently online. Defaults to
falseWhether the driver is available to accept trips. Defaults to
falseDriver’s last known location
Timestamp of the last location update (ISO 8601)
UUID of the current active trip, or
null if no active tripUUID of the vehicle currently being used, or
null if noneTimestamp when the driver last went online (ISO 8601)
Response
Indicates if the operation was successful
Response message
Created driver availability record
Get Driver Availability by Driver
Path Parameters
UUID of the driver
Response
Indicates if the operation was successful
Response message
Driver availability record
Get Authenticated Driver Availability
Headers
Bearer token for authentication
Response
Indicates if the operation was successful
Response message
Driver availability record
Find Nearby Drivers
Query Parameters
Latitude of the search location
Longitude of the search location
Search radius in meters (default: 2000m)
Maximum number of drivers to return (default: 50)
Response
Indicates if the operation was successful
Response message
Array of nearby available drivers with distance information
Upsert Driver Availability
Body Parameters
UUID of the driver
Online status
Trip availability status
Location coordinates
Location timestamp (ISO 8601)
Online timestamp (ISO 8601)
Current trip UUID or
nullCurrent vehicle UUID or
nullResponse
Indicates if the operation was successful
Response message
Created or updated availability record
Ping Location
Headers
Bearer token for authentication
Body Parameters
Current latitude (if provided, triggers location update)
Current longitude (if provided, triggers location update)
Response
Indicates if the operation was successful
Response message
Updated availability record
This endpoint is rate-limited to prevent excessive updates. If lat/lng are provided, the location is updated only if the driver has moved beyond a minimum threshold. Without coordinates, it acts as a heartbeat ping.
Update Driver Status
Path Parameters
UUID of the driver
Body Parameters
New online status
New trip availability status
Reason for unavailability, or
null to clearOFFLINE- Driver is offlineON_TRIP- Driver is on an active tripUNAVAILABLE- Driver is unavailable for other reasons
Response
Indicates if the operation was successful
Response message
Updated availability record
Update Status by Driver
Headers
Bearer token for authentication
Body Parameters
New online status
New trip availability status
Reason for unavailability
OFFLINEON_TRIPUNAVAILABLE
Response
Indicates if the operation was successful
Response message
Updated availability record
Update Location
Path Parameters
UUID of the driver
Body Parameters
Latitude coordinate
Longitude coordinate
Timestamp of the location update (ISO 8601)
Response
Indicates if the operation was successful
Response message
Updated availability record
Set or Clear Current Trip
Path Parameters
UUID of the driver
Body Parameters
UUID of the trip to assign, or
null to clear the current tripResponse
Indicates if the operation was successful
Response message
Updated availability record
Delete Driver Availability
Path Parameters
UUID of the driver
Response
Indicates if the operation was successful
Response message
Returns null for deleted resources