Vehicles

List Archived Vehicles

Returns a list of archived vehicles.

get/vehicles/archived

Request

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return

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.

archived_at'asc' | 'desc'
id'asc' | 'desc'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

Example response

{
  "records": [
    {
      "archived_at": "2023-03-14T13:46:27-06:00",
      "primary_meter_date": "2023-03-14T13:46:27-06:00",
      "secondary_meter_date": "2023-03-14T13:46:27-06:00",
      "in_service_date": "2023-03-14T13:46:27-06:00",
      "out_of_service_date": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

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