Driver Schema

Model

Driver

Ƭ Driver: Object

The driver data. All drivers in the API will have this format.

Example

{
  "id": "drivers/w8ZaNn3e5ZA8EQSABtca",
  "name": "John Doe",
  "email": "john.doe@getcircuit.com",
  "phone": "+15555555555",
  "displayName": "John D.",
  "active": true
}

Type declaration

Name	Type	Description
id	DriverId	-
name	string | null	Full user name Default ts null
email	string | null	User email Default ts null
phone	string | null	Phone number in E.164 format Default ts null
displayName	string | null	User name for display purposes
active	boolean	If true, the driver membership is active and the driver can be assigned to plans/routes. If false, the driver membership is paused and the driver will not be assignable to any plans/routes.

Identifier

DriverId

Ƭ DriverId: `drivers/${string}`

A driver id is a string that is unique for a driver. It is used to identify the driver in the API.

Example

"drivers/0xBYy4MYt4piMCSQEsts"