GET
/drivers List Drivers
Returns a Spring Page envelope (content, page, size, totalElements, totalPages). Supports all criteria operators on filterable fields — see the Filtering & Sorting guide. The unique `keyword` param does a full-text search across name, surname, email, and username. The response includes the nested truck object when a driver is assigned to one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
keyword | query | string | Full-text search across name, surname, email, and username.
e.g. Martinez |
name.contains | query | string | First name contains substring.
e.g. Jorge |
surname.contains | query | string | Last name contains substring. |
email.equals | query | string | Exact email match. |
username.equals | query | string | Exact username match. |
active.equals | query | boolean | Filter by active flag. truefalse |
truckId.equals | query | integer | Filter drivers assigned to a specific truck id. |
companyId.equals | query | integer | Filter by owning company id. |
cdlClass.equals | query | string | Filter by CDL class. ABC |
page | query | integer | Zero-based page index.
e.g. 0 |
size | query | integer | Page size. Default 20.
e.g. 20 |
sort | query | string | Sort as `property,(asc|desc)`. Repeatable.
e.g. surname,asc |
The explorer shows the most common query parameters. For the full
operator grammar (
.equals, .contains, .greaterThan, .in, .specified …) see the
Filtering & Sorting
guide.
Response
Status: Stable. Try the request in the panel on the right to see a live response.