Skip to main content

List Vehicles

Returns a list of your vehicles. Defaults to only returning non-archived vehicles, but you can include archived vehicles in the results as well.

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).

Schema

array
  • id int32

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • account_id int32

    Possible values: >= 1

  • archived_at date-time

    The date and time at which the Vehicle was archived.

  • fuel_type_id NullableId

    Possible values: >= 1

  • fuel_type_name string

    The name of the Fuel Type associated with this Vehicle.

  • fuel_volume_units VolumeUnit

    Possible values: [us_gallons, uk_gallons, liters]

    Default value: us_gallons

  • group_id NullableId

    Possible values: >= 1

  • group_name string

    The name of the Group associated with this Vehicle.

  • meter_unit MeterUnit

    Possible values: [km, hr, mi]

    The measurement unit used a Vehicle meter

  • name string

    This Vehicle's name.

  • ownership VehicleOwnership

    Possible values: [Owned, owned, leased, Leased, rented, Rented, customer, Customer]

    Default value: owned

  • secondary_meter boolean

    Indicates whether or not this Vehicle has a secondary meter.

  • secondary_meter_unit MeterUnit

    Possible values: [km, hr, mi]

    The measurement unit used a Vehicle meter

  • system_of_measurement MeasurementSystem

    Possible values: [imperial, metric]

    Default value: imperial

  • vehicle_status_id int32

    Possible values: >= 1

  • vehicle_status_name string

    The name of the Vehicle Status associated with this Vehicle.

  • vehicle_status_color string

    The color of the Vehicle Status associated with this Vehicle.

  • vehicle_type_id int32

    Possible values: >= 1

  • vehicle_type_name string

    The name of the Vehicle Type associated with this Vehicle.

  • fuel_entries_count integer
  • service_entries_count integer
  • service_reminders_count integer
  • vehicle_renewal_reminders_count integer
  • comments_count integer
  • documents_count integer
  • images_count integer
  • current_location_entry_id NullableId

    Possible values: >= 1

  • is_sample boolean
  • in_service_date date-time

    The date on which this Vehicle was put into service.

  • in_service_meter number
  • estimated_service_months integer

    The estimated number of months this Vehicle will be in service.

  • estimated_replacement_mileage integer

    The estimated number of miles before which this Vehicle will be replaced.

  • estimated_resale_price number

    The estimated resale price of this Vehicle.

  • out_of_service_date date-time

    The date on which this Vehicle was or will be retired.

  • out_of_service_meter number

    The meter value at which this Vehicle was or will be retired.

  • meter_name string

    The name of the primary meter for this Vehicle.

  • secondary_meter_name string

    The name of the secondary meter for this Vehicle.

  • primary_meter_usage_per_day number

    The average number of units of the primary meter used per day.

  • secondary_meter_usage_per_day number

    The average number of units of the secondary meter used per day.

  • current_meter_value number

    The current value of the primary meter for this Vehicle.

  • current_meter_date date-time

    The date and time at which the primary meter was last updated.

  • secondary_meter_value number

    The current value of the secondary meter for this Vehicle.

  • secondary_meter_date date-time

    The date and time at which the secondary meter was last updated.

  • group_ancestry string

    The ancestry of the Group associated with this Vehicle.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufaturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state in which this Vehicle is registered.

  • loan_account_number string
  • loan_ended_at date-time

    The date and time at which this Vehicle's loan ends.

  • loan_interest_rate string

    The interest rate for this Vehicle's loan.

  • loan_notes string

    Notes about this Vehicle's loan.

  • loan_started_at date-time

    The date and time at which this Vehicle's loan began.

  • loan_vendor_id NullableId

    Possible values: >= 1

  • loan_vendor_name string

    The name of the vendor for this Vehicle's loan.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • inspection_schedules_count integer
  • issues_count integer
  • work_orders_count integer
  • type_name string
  • default_image_url string
  • default_image_url_medium string
  • default_image_url_small string
  • default_image_url_large string
  • specs object
  • engine_bore_with_units string
  • wheelbase_with_units string
  • ai_enabled boolean
  • assetable_type string
  • driver object
  • current_location_entry object
  • documents_including_nested_resources_count integer
  • labels object[]
  • id int32

    Possible values: >= 1

  • name string
Loading...