/shipping/drivers

List

Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)

get/shipping/drivers/list/v1

Query parameters

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc)

pageinteger
page_sizeinteger
searchstring nullable

Full-text search query

Full-text search query

filter_waitingboolean nullable

Filter by waiting status

Filter by waiting status

filter_auto_assign_enabledboolean nullable

Filter by automatic assignment consent

Filter by automatic assignment consent

filter_vehicle_typeVehicleTypeEnum[] nullable

Filter by any matching vehicle type

Filter by any matching vehicle type

filter_by_driver_idstring nullable

Filter by driver ID

Filter by driver ID

filter_archivedboolean

Select archived drivers instead of active drivers

Select archived drivers instead of active drivers

filter_available_according_to_driverboolean nullable

Filter by driver's self-reported availability

Filter by driver's self-reported availability

filter_available_according_to_operatorsboolean nullable

Filter by operator-set availability

Filter by operator-set availability

filter_statusDriverStatusEnum[] nullable

Filter by driver state (UNASSIGNED / ASSIGNED / IN_PROGRESS)

Filter by driver state (UNASSIGNED / ASSIGNED / IN_PROGRESS)

Response

Successful Response

itemsDriverWithActiveTaskGroupIds1[] required— unresolved $ref
total_countinteger required

Changes