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",
"active": true
}
Type declaration
Name | Type | Description |
---|---|---|
id | DriverId | - |
name | string | null | Full user name Default null |
email | string | null | User email Default null |
phone | string | null | Phone number in E.164 format Default null |
active | boolean | Whether 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"