Search the drivers of the tenant by name or driver number, one page at a time.

This endpoint finds the driverId that other endpoints require when you only know a driver name or number.
search is one word matched against the first name, the last name or the driver number: search "Tremblay", not
"Jean Tremblay"; leave it empty to browse all drivers. Each driver comes with its id, names, number, status, email,
phone number, attribute ids and archived flag; driverFields stays empty. driverStatus: 0 Online, 1 Away, 2 Offline,
3 GoingOffline; excludeOffline keeps the Online, Away and GoingOffline drivers. total is the number of matching
drivers: while pageNumber multiplied by pageSize is below total, call again with pageNumber + 1. Only active drivers
are returned unless includeArchived is true. Call GET api/v1/drivers/{id} only for a field that the search does not
return. To list the orders of a driver, search the orders with DriverId IsEqualTo its id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params

Text to look for; the fields it is matched against are listed by each endpoint. Leave empty to list everything.

int32
1 to 10000

The page to return, starting at 1.

int32
1 to 200

The number of items per page, 50 by default and 200 at most.

boolean
Defaults to false

When true, archived drivers are included in the results.

boolean
Defaults to false

When true, only the Online, Away and GoingOffline drivers are returned.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

An error occurred while trying to search the drivers.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json