Sign in
/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_driver_idsstring[] nullable

Filter by selected driver ids

Filter by selected driver ids

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_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

Changed in 3 of the 9 revisions of this API.17

  • b5a0a0e20ff811See the full diff
    • ●

      deleted the query request parameter filter_by_driver_id

      request-parameter-removed

    • ○

      added the new optional query request parameter filter_driver_ids

      new-optional-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 90f02389cb0d3See the full diff
    • ○

      added the new optional query request parameter filter_auto_assign_enabled

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter_vehicle_type

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter_waiting

      new-optional-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cf3611256753See the full diff
    • ○

      added the new optional query request parameter filter_archived

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter_by_driver_id

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog