Skip to main content
GET
List Driver Agreements

Authorizations

Authorization
string
header
required

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

Headers

Fleet-Id
integer
required

ID of the Fleet making the request.

Example:

123

Response

200 - application/json

Successful Response

id
integer

Unique identifier for the driver agreement.

Example:

5001

vehicle
object

Vehicle associated with the driver agreement.

agreement_status
string

Current status of the agreement (e.g., ACTIVE, EXPIRED).

Example:

"ACTIVE"

agreement_start_date
string<date-time>

Start date of the agreement.

Example:

"2025-03-01T00:00:00Z"

agreement_end_date
string<date-time>

End date of the agreement.

Example:

"2025-06-30T00:00:00Z"

date_added
string<date-time>

Date the agreement was added to the system.

Example:

"2025-02-01T12:00:00Z"

last_updated
string<date-time>

Date the agreement was last updated.

Example:

"2025-02-15T15:30:00Z"

agreement_number
string

Unique agreement number.

Example:

"AGMT-2025-001"

driver
integer

ID of the driver linked to this agreement.

Example:

3001

parent_agreement
string | null

ID of the parent agreement if this is a sub-agreement.

Example:

null