3.3 Search Driver
Updated at: 3/27/2023 1:56:47 AM
Url
/api/v2/{fleet_token}/contractors/{contractor_id}/drivers/search
Method
Post
Body
```
{
"DriverNumber": "<driver_number>",
"IncludeClosed": "<true|false>",
"UnitID": "<unit_id>"
}
```
Parameters
- `DriverNumber`. Optional.
- `IncludeClosed`. Optional. default to false.
- 'UnitID`. Optional.
Response
```json
{
"Success": "<true|false>",
"Message": "<message>",
"Data":
[
{
"ID": "<driver_id>",
"Number": "<driver_number>",
"FirstName": "<first_name>",
"MiddleName": "<middle_name>",
"LastName": "<last_name>",
"Dob": "<dob:Date>",
"Email": "<email>",
"PhoneNumber": "<phone_number>",
"CellNumber": "<cell_number>",
"Address": "<address>",
"Address2": "<address2>",
"City": "<city>",
"State": "<state>",
"Zip": "<zip>",
"License": "<license>",
"LicenseState": "<license_state>",
"InactivationDate": "<date:Date>"
}
]
}
```
Returns
- The API returns a list of matched drivers.
- `InactivationDate` is an optional field, it will be there if closed drivers are included in the results.
Notes
- The request would fail if it fails to locate the motor carrier by `fleet_token`.
- Drivers will be searched by unit level if `UnitID` is present.
In this article