Skip to main content
GET
List Drivers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

filter
string

Generic filter that matches against

  • licenseNumber
  • name
  • email
Example:

"john"

licenseCategory
enum<string>

License category

Available options:
D,
E
Example:

"D"

licenseExpiresAt
string

License expiry range

Example:

">=2024-01-01;<=2024-12-31"

transportOperatorId
string<uuid>

Transport operator identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

transportOperatorStatus
enum<string>

Driver transport operator status

Available options:
PENDING_APPROVAL,
ACTIVE,
INACTIVE,
SUSPENDED
Example:

"ACTIVE"

createdAt
string

Created at range

Example:

">=2024-01-01;<=2024-12-31"

status
enum<string>

User status

Available options:
PENDING,
ACTIVE,
BLOCKED
Example:

"ACTIVE"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
licenseExpiresAt
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List drivers

data
object[]
required
meta
object
required