Skip to main content
GET
/
v2
/
driver-agreements
/
{id}
cURL
curl --request GET \
  --url https://api.example.com/v2/driver-agreements/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "custom_fields": "<string>",
  "vehicle": {
    "id": 123,
    "custom_fields": "<string>",
    "added_date": "2023-11-07T05:31:56Z",
    "fleet": {
      "id": 123,
      "region_details": [
        {
          "id": 123,
          "title": "<string>"
        }
      ],
      "title": "<string>",
      "is_active": true,
      "billing_type": "PREPAID",
      "onboarding_stage": "INITIAL",
      "warning_threshold_per_vehicle": "<string>",
      "deactivation_threshold_per_vehicle": "<string>",
      "client": "<string>",
      "onboarding_vehicle_order": 123
    },
    "plate_number": "<string>",
    "plate_state": "<string>",
    "vehicle_number": "<string>",
    "active": true,
    "vehicle_make": "<string>",
    "vehicle_model": "<string>",
    "year": "<string>",
    "lessee_renter": "<string>",
    "vehicle_type_code": "<string>"
  },
  "driver": {
    "id": 123,
    "first_name": "<string>",
    "address_line_1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "email": [
      "jsmith@example.com"
    ],
    "driver_id": "<string>",
    "last_name": "<string>",
    "address_line_2": "<string>",
    "contact_number": "<string>"
  },
  "status": "<string>",
  "agreement_start_date": "2023-11-07T05:31:56Z",
  "date_added": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z",
  "agreement_number": "<string>",
  "agreement_status": "ACTIVE",
  "agreement_end_date": "2023-11-07T05:31:56Z",
  "plan": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

A unique integer value identifying this Driver Agreement.

Response

200 - application/json
id
integer
required
custom_fields
string
required
vehicle
object
required
driver
object
required
status
string
required
agreement_start_date
string<date-time>
required
date_added
string<date-time>
required
last_updated
string<date-time>
required
agreement_number
string
required
Maximum string length: 255
agreement_status
enum<string>
  • ACTIVE - Active
  • INACTIVE - In-active
Available options:
ACTIVE,
INACTIVE
agreement_end_date
string<date-time> | null
plan
string | null
Maximum string length: 255