List Archived Vehicles

GET 
https://secure.fleetio.com/api/v1/vehicles/archived

Returns a list of archived vehicles.

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return
Default value: 50
filter object
The fields, operations, and values to filter the records by. If you have configured custom fields, These will be filterable using the custom field key with the prefix custom_field_, and support like and eq operations.
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
vin object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
license_plate object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
external_id object
likestringrequired
archived_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set. If you have filtered by custom field filters, these will be returned with the respective like or eq filter value.
Array [
anyOf
MOD1
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD2
vin object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD3
license_plate object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD4
external_id object
eqstringrequired
MOD5
archived_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
archived_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
account_idinteger
archived_atdate-timenullable
The iso8601 date and time at which the vehicle was archived, for an archived vehicle.
Example: 2023-03-14T13:46:27-06:00
fuel_type_idintegernullable
fuel_type_namestringnullable
The name of the Fuel Type associated with this vehicle.
fuel_volume_unitsVolumeUnit (string)
Possible values: [us_gallons, uk_gallons, liters]
group_idintegernullable
group_namestringnullable
The name of the Group associated with this vehicle, for vehicles associated with a group.
namestring
This vehicle's name.
ownershipVehicleOwnershipResponse (string)
Possible values: [Owned, Leased, Rented, Customer]
current_location_entry_idintegernullable
system_of_measurementMeasurementSystem (string)
Possible values: [imperial, metric]
vehicle_type_idinteger
This vehicles Vehicle Type id.
vehicle_type_namestring
The name of the Vehicle Type associated with this Vehicle.
is_sampleboolean
Indicates whether this Vehicle record is Sample Data.
vehicle_status_idinteger
The id of the Vehicle Status of this vehicle.
vehicle_status_namestring
The name of the Vehicle Status associated with this Vehicle.
vehicle_status_colorstringnullable
The hex color code of the Vehicle Status associated with this Vehicle.
primary_meter_unitMeterUnit (string)nullable
The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
Possible values: [km, hr, mi]
primary_meter_valuestringnullable
The current value of the primary meter for this Vehicle.
primary_meter_datedate-timenullable
The date and time at which the primary meter was last updated.
Example: 2023-03-14T13:46:27-06:00
primary_meter_usage_per_daystringnullable
The average number of units of the primary meter used per day.
secondary_meter_unitMeterUnit (string)nullable
The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
Possible values: [km, hr, mi]
secondary_meter_valuestringnullable
The current value of the secondary meter for this Vehicle.
secondary_meter_datedate-timenullable
The date and time at which the secondary meter was last updated.
Example: 2023-03-14T13:46:27-06:00
secondary_meter_usage_per_daystringnullable
The average number of units of the secondary meter used per day.
in_service_meter_valuestringnullable
The meter value at which this Vehicle was put into service.
in_service_datedate-timenullable
The date on which this Vehicle was put into service.
Example: 2023-03-14T13:46:27-06:00
out_of_service_meter_valuestringnullable
The meter value at which this Vehicle was or will be retired.
out_of_service_datedate-timenullable
The date on which this Vehicle was or will be retired.
Example: 2023-03-14T13:46:27-06:00
estimated_service_monthsintegernullable
The estimated number of months this Vehicle will be in service.
estimated_replacement_mileagestringnullable
The estimated number of miles before which this Vehicle will be replaced.
estimated_resale_price_centsintegernullable
The estimated resale price of this Vehicle in cents.
fuel_entries_countinteger
The number of Fuel Entries associated with this Vehicle.
Possible values: >= 0
service_entries_countinteger
The number of Service Entries associated with this Vehicle.
Possible values: >= 0
service_reminders_countinteger
The number of Service Reminders associated with this Vehicle.
Possible values: >= 0
vehicle_renewal_reminders_countinteger
The number of Vehicle Renewal Reminders associated with this Vehicle.
Possible values: >= 0
comments_countinteger
The number of Comments associated with this Vehicle.
Possible values: >= 0
documents_countinteger
The number of documents attached to this Vehicle.
Possible values: >= 0
images_countinteger
The number of images attached to this Vehicle.
Possible values: >= 0
issues_countinteger
The number of Issues this Vehicle is associated with.
Possible values: >= 0
work_orders_countinteger
The number of Work Orders this Vehicle is associated with.
Possible values: >= 0
labels object[]
Array [
idId (integer)
Possible values: >= 1
namestring
]
group_ancestrystringnullable
The ancestry of the Group associated with this Vehicle.
colorstringnullable
The color of this Vehicle.
license_platestringnullable
The license plate number of this Vehicle.
vinstringnullable
The Vehicle Identification Number of this Vehicle.
yearstringnullable
This Vehicle's model year.
makestringnullable
The name of this Vehicle's manufacturer.
modelstringnullable
The name of the model of this Vehicle.
trimstringnullable
The trim level of this Vehicle.
registration_expiration_monthintegernullable
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
registration_statestringnullable
The state, province, or territory in which this Vehicle is registered.
default_image_url_smallstringnullable
The URL of a small-sized version of the default image for this Vehicle.
external_idsobject
Any External IDs associated with this Vehicle.
ai_enabledboolean
Whether this Vehicle has Auto Integrate enabled for it.
assetable_typestring
Assetable type for Vehicle is always Vehicle for vehicles.
Possible values: [Vehicle]
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
axle_config_idintegernullable
The id of the Axle Configuration of this vehicle.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "name": {
        "like": "string"
      }
    },
    {
      "vin": {
        "like": "string"
      }
    },
    {
      "license_plate": {
        "like": "string"
      }
    },
    {
      "external_id": {
        "eq": "string"
      }
    },
    {
      "archived_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "archived_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "account_id": 0,
      "archived_at": "2023-03-14T13:46:27-06:00",
      "fuel_type_id": 0,
      "fuel_type_name": "string",
      "fuel_volume_units": "us_gallons",
      "group_id": 0,
      "group_name": "string",
      "name": "string",
      "ownership": "Owned",
      "current_location_entry_id": 0,
      "system_of_measurement": "imperial",
      "vehicle_type_id": 0,
      "vehicle_type_name": "string",
      "is_sample": true,
      "vehicle_status_id": 0,
      "vehicle_status_name": "string",
      "vehicle_status_color": "string",
      "primary_meter_unit": "km",
      "primary_meter_value": "string",
      "primary_meter_date": "2023-03-14T13:46:27-06:00",
      "primary_meter_usage_per_day": "string",
      "secondary_meter_unit": "km",
      "secondary_meter_value": "string",
      "secondary_meter_date": "2023-03-14T13:46:27-06:00",
      "secondary_meter_usage_per_day": "string",
      "in_service_meter_value": "string",
      "in_service_date": "2023-03-14T13:46:27-06:00",
      "out_of_service_meter_value": "string",
      "out_of_service_date": "2023-03-14T13:46:27-06:00",
      "estimated_service_months": 0,
      "estimated_replacement_mileage": "string",
      "estimated_resale_price_cents": 0,
      "fuel_entries_count": 0,
      "service_entries_count": 0,
      "service_reminders_count": 0,
      "vehicle_renewal_reminders_count": 0,
      "comments_count": 0,
      "documents_count": 0,
      "images_count": 0,
      "issues_count": 0,
      "work_orders_count": 0,
      "labels": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "group_ancestry": "string",
      "color": "string",
      "license_plate": "string",
      "vin": "string",
      "year": "string",
      "make": "string",
      "model": "string",
      "trim": "string",
      "registration_expiration_month": 0,
      "registration_state": "string",
      "default_image_url_small": "string",
      "external_ids": {},
      "ai_enabled": true,
      "assetable_type": "Vehicle",
      "custom_fields": {},
      "axle_config_id": 0
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/vehicles/archived' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

start_cursor — query

per_page — query

filter — query

namelikeeq

vinlikeeq

license_platelikeeq

external_idlike

archived_atltltegtgte

ResponseClear

Click the Send API Request button above and see the response here!