Drivers

Retrieve a driver

get/drivers/{driverId}

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/drivers/:driverId/get.ts
A function with typed inputs. Its response is checked against the schema.

driverIdstring required

The driver id

The requested driver

idstring required

namestring nullable required

The name of the driver.

emailstring nullable required

The email of the driver.

phonestring nullable required

The phone number of the driver.

displayNamestring nullable required

The display name of the driver.

activeboolean required

Whether the driver membership is active or paused. Paused drivers will not be assigned to any routes.

depotsDepotIdSchema[] required

Depots associated with the driver.

No recorded changes to this operation across all 1 revision of this API.