CHchrt
/shipping/drivers

List

Changed on

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

get/shipping/drivers/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/shipping/drivers/list/v1
  • Auth
    HTTP bearer

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

filter_driver_idsstring[] nullable

Filter by selected driver ids

filter_waitingboolean nullable

Filter by waiting status

filter_auto_assign_enabledboolean nullable

Filter by automatic assignment consent

filter_vehicle_typeVehicleTypeEnum[] nullable

Filter by any matching vehicle type

filter_archivedboolean

Select archived drivers instead of active drivers

filter_available_according_to_driverboolean nullable

Filter by driver's self-reported availability

filter_available_according_to_operatorsboolean nullable

Filter by operator-set availability

filter_statusDriverStatusEnum[] nullable

Filter by driver state (UNASSIGNED / ASSIGNED / IN_PROGRESS)

Response

Successful Response

total_countinteger required

Changes

  • b5a0a0e20ff8Revision changes
    • warning

      deleted the query request parameter filter_by_driver_id

    • info

      added the new optional query request parameter filter_driver_ids

  • 90f02389cb0dRevision changes
    • info

      added the new optional query request parameter filter_auto_assign_enabled

    • info

      added the new optional query request parameter filter_vehicle_type

    • info

      added the new optional query request parameter filter_waiting