Skip to main content
GET
List Driver

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Query Parameters

pageIndex
integer<int32>

Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.

pageSize
integer<int32>

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.

name
string

Name of the driver

groupId
string

Id of the group in hierarchy

groupName
string

Name of the group in hierarchy

active
boolean

If driver is active (true = active, false = inactive)

defaultVehicleId
string

Id of default vehicle

keys
string[]

List of driver keys for filtering

Response

Drivers were successfully returned or empty if none of drivers fulfill criteria

totalPages
integer<int32>

Total number of pages based on the pageSize.

totalCount
integer<int64>

Total number of items that matched the search parameters.

items
object[]

Array of items.