Skip to main content
GET
List Drivers

Authorizations

Authorization
string
header
default:Token <api-key>
required

Send your API key with the Token prefix: Authorization: Token <api-key>.

Query Parameters

page
integer

Page number for paginated results.

Required range: x >= 1
Example:

1

page_size

Results per page. Default: 10. Use a positive integer, or all for every result on one page. No maximum.

Required range: x >= 1
Example:

10

ordering
string

ORM field path to order by. Prefix with - for descending.

Example:

"account__last_name"

filter
string

JSON-encoded array of filter objects. Each object has column, value, and contains (operator). Supported operators: is, is_not, is_in, is_not_in, contains, before, after, greater_than, less_than, between, between_datetime, isnull, today, exclude, exclude_in.

Example:

"[{\"column\":\"driver_type\",\"value\":\"Owner Operator\",\"contains\":\"is\"}]"

Response

200 - application/json

Successful response with a paginated list of drivers.

count
integer
required

Total number of drivers.

next
string | null
required

URL to the next page of results.

previous
string | null
required

URL to the previous page of results.

results
object[]
required

List of driver entries.