Sign in

List all the vehicles of a company

get/v1/vehicles

Query parameters

driver_ids[]integer[]

Specify the ID of the driver whose vehicle details you are fetching.

fuel_typestring

Specify the fuel type of the vehicles. Allowed values are: diesel, gasoline, propane, lng, cng, ethanol, methanol, e85, m85, a55, biodiesel, and other.

updated_after (optional)string date-time

Denotes the date and time in UTC format for fetching the details of the vehicle that are updated after the parameter value. For example: 2023-10-04T00:00:00Z

per_pageinteger

Number of records to return per page.

page_nointeger

Current page number.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Response

200

Example response

{
  "vehicles": [
    {
      "vehicle": {
        "id": 6620,
        "company_id": 2178,
        "number": "6620",
        "status": "active",
        "ifta": true,
        "make": "Freightliner",
        "model": "Conv",
        "year": "2006",
        "fuel_type": "diesel",
        "created_at": "2017-01-01T00:00:00Z",
        "updated_at": "2024-07-31T05:30:53Z",
        "eld_device": {
          "id": 746694,
          "identifier": "AABL36FB400300",
          "model": "lbb-3.6ca"
        }
      },
      "availability_details": {
        "availability_status": "out_of_service",
        "out_of_service_reason": "Vehicle Maintenance",
        "updated_at": "2024-07-31T05:30:53Z",
        "additional_note": "This vehicle is scheduled for maintenance",
        "custom_driver_app_warning_prompt": "This vehicle is scheduled for maintenance, please don't operate",
        "updated_by_user": {
          "id": 123,
          "first_name": "First",
          "last_name": "Last",
          "user_name": "demo_dispatcher",
          "email": "demo.dispatcher@gmail.com",
          "company_reference_id": 1234,
          "status": "active",
          "role": "dispatcher"
        }
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 2192
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.