---
title: "List Drivers"
method: GET
path: "/drivers"
tags: ["Drivers"]
---

# List Drivers

`GET /drivers`

## Request

- Base URL: `https://api.spoke.com/public/v1`
- URL: `https://api.spoke.com/public/v1/drivers`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spoke/apis/spoke-api/docs/drivers/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `maxPageSize` number
- `pageToken` string
- `filter` object
  - `active` 'true' | 'false': Filter by the active status of the driver. Inactive drivers will not be assigned to any routes.

## Response `200`

Success

- object: Success
  - `drivers` DriverSchema[], required: The drivers.
    - `id` string, required
    - `name` string, nullable, required: The name of the driver.
    - `email` string, nullable, required: The email of the driver.
    - `phone` string, nullable, required: The phone number of the driver.
    - `displayName` string, nullable, required: The display name of the driver.
    - `active` boolean, required: Whether the driver membership is active or paused. Paused drivers will not be assigned to any routes.
    - `depots` DepotIdSchema[], required: Depots associated with the driver.
    - `routeOverrides` object, required: Settings to override default route settings.
      - `startTime` TimeOfDaySchema, required: Time of day in hours and minutes. Uses a 24 hour clock.
        - `hour` integer, required: Hour of the day
        - `minute` integer, required: Minute of the hour
      - `endTime` TimeOfDaySchema, required: Time of day in hours and minutes. Uses a 24 hour clock.
        - `hour` integer, required: Hour of the day
        - `minute` integer, required: Minute of the hour
      - `startAddress` object, nullable, required: The address of the stop.
        - `address` string, required: The address of the stop.
        - `addressLineOne` string, required: The first line of the address.
        - `addressLineTwo` string, required: The second line of the address.
        - `latitude` number, nullable, required: The latitude of the address in decimal degrees.
        - `longitude` number, nullable, required: The longitude of the address in decimal degrees.
        - `placeId` string, nullable, required: The identifier of the place corresponding to this stop on Google Places
        - `placeTypes` string[], required: Array of strings that is provided by the Google AutoCompleteAPI
      - `endAddress` object, nullable, required: The address of the stop.
        - `address` string, required: The address of the stop.
        - `addressLineOne` string, required: The first line of the address.
        - `addressLineTwo` string, required: The second line of the address.
        - `latitude` number, nullable, required: The latitude of the address in decimal degrees.
        - `longitude` number, nullable, required: The longitude of the address in decimal degrees.
        - `placeId` string, nullable, required: The identifier of the place corresponding to this stop on Google Places
        - `placeTypes` string[], required: Array of strings that is provided by the Google AutoCompleteAPI
      - `maxStops` integer, nullable, required: Maximum number of Stops the Driver can take in a route.
      - `drivingSpeed` 'slower' | 'average' | 'faster', required: The relative driving speed of the driver compared to others.
      - `deliverySpeed` 'slower' | 'average' | 'faster', required: The relative delivery speed of the driver compared to others.
      - `vehicleType` 'bike' | 'scooter' | 'car' | 'small_truck' | 'truck' | 'electric_cargo_bike', nullable, required: The vehicle type the driver will be using for deliveries.
  - `nextPageToken` string, nullable, required: The next page token.

## Other responses

- `400`: Query parameters are invalid
- `401`: Unauthorized
- `500`: An internal server error occurred
- `default`: The default error model

---

[API](https://skmtc.dev/spoke/apis/spoke-api.md) - [All operations](https://skmtc.dev/spoke/apis/spoke-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spoke/apis/spoke-api/revisions/a09d9194ae1c?raw)