Skip to main content
Version: v0.2b

Driver Schema

Type Aliases

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

NameTypeDescription
idDriverId-
namestring | nullFull user name Default null
emailstring | nullUser email Default null
phonestring | nullPhone number in E.164 format Default null
displayNamestring | nullUser name for display purposes
activebooleanWhether the driver is active

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"