List Drivers - Documentação DEVMOB

{ "data": [ { "driverCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "driverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" } ], "meta": { "page": 1, "limit": 20, "total": 125, "totalPages": 7 } }

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 license number, name, or email

Example:

"john"

licenseCategory

enum<string>

Driver license category

Available options:

D,

E

Example:

"D"

licenseExpiresAt

string

Driver license expiration range

Example:

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

companyStatus

enum<string>

Driver company status

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

createdAt

string

Created at range

Example:

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

status

enum<string>

User status

Available options:

PENDING,

ACTIVE

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

data

object[]

required

Show child attributes