{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vehicles","auth":"required","method":"get","params":[{"name":"include_archived","type":"string","default":"0","desc":"Flag to include archived vehicles in the results.","required":false,"in":"query","ref":"","_id":"5bf33ec30b07070049c17c7e"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\":1051653,\n    \"account_id\":18,\n    \"archived_at\":null,\n    \"fuel_type_id\":37,\n    \"fuel_type_name\":\"Gasoline\",\n    \"fuel_volume_units\":\"us_gallons\",\n    \"group_id\":23966,\n    \"group_name\":\"Birmingham\",\n    \"meter_unit\":\"mi\",\n    \"name\":\"2001 Honda Pilot\",\n    \"ownership\":\"Owned\",\n    \"secondary_meter\":false,\n    \"secondary_meter_unit\":null,\n    \"system_of_measurement\":\"imperial\",\n    \"vehicle_status_id\":3261,\n    \"vehicle_status_name\":\"Active\",\n    \"vehicle_status_color\":\"green\",\n    \"vehicle_type_id\":162276,\n    \"vehicle_type_name\":\"SUV\",\n    \"fuel_entries_count\":0,\n    \"service_entries_count\":0,\n    \"service_reminders_count\":3,\n    \"vehicle_renewal_reminders_count\":0,\n    \"comments_count\":0,\n    \"documents_count\":0,\n    \"images_count\":1,\n    \"current_location_entry_id\":null,\n    \"is_sample\":false,\n    \"in_service_date\":\"2020-02-01\",\n    \"in_service_meter\":129000.0,\n    \"estimated_service_months\":null,\n    \"estimated_replacement_mileage\":null,\n    \"estimated_resale_price\":null,\n    \"out_of_service_date\":null,\n    \"out_of_service_meter\":null,\n    \"meter_name\":\"Odometer\",\n    \"secondary_meter_name\":\"Secondary Meter\",\n    \"created_at\":\"2020-09-11T14:27:31.134-05:00\",\n    \"updated_at\":\"2020-09-11T14:38:13.637-05:00\",\n    \"current_meter_value\":146005.0,\n    \"current_meter_date\":\"2020-09-11\",\n    \"secondary_meter_value\":0.0,\n    \"secondary_meter_date\":null,\n    \"group_ancestry\":\"Southeast Region / Alabama / Birmingham\",\n    \"color\":\"Gray\",\n    \"license_plate\":\"18AR223\",\n    \"make\":\"Honda\",\n    \"model\":\"Pilot\",\n    \"registration_expiration_month\":0,\n    \"registration_state\":\"AL\",\n    \"trim\":\"EX-L\",\n    \"vin\":\"5FNYF4H5XBB071234\",\n    \"year\":2011,\n    \"loan_account_number\":null,\n    \"loan_ended_at\":null,\n    \"loan_interest_rate\":null,\n    \"loan_notes\":null,\n    \"loan_started_at\":null,\n    \"loan_vendor_id\":null,\n    \"loan_vendor_name\":null,\n    \"custom_fields\":{\n      \"telematics_subscription\":\"Gold Annual\",\n      \"warranty_expiration\":\"2017-08-01\"\n    },\n    \"inspection_schedules_count\":9,\n    \"issues_count\":0,\n    \"work_orders_count\":0,\n    \"type_name\":\"SUV\",\n    \"default_image_url\":\"https://d8g9nhlfs6lwh.cloudfront.net/h5YQhErqRf6SGqO6tsWY\",\n    \"default_image_url_medium\":\"https://d8g9nhlfs6lwh.cloudfront.net/security=policy:eyJleHBpcnkiOjQ1MzQ5NDkzNDMsImNhbGwiOlsicmVhZCIsImNvbnZlcnQiXSwiaGFuZGxlIjoiaDVZUWhFcnFSZjZTR3FPNnRzV1kifQ==,signature:4b3a3266bac621e9041b83f3d20d02663374994866c4a02cca60916c1eda3cd9/resize=w:100,h:100,fit:crop/cache=expiry:max/rotate=exif:true/h5YQhErqRf6SGqO6tsWY\",\n    \"default_image_url_small\":\"https://d8g9nhlfs6lwh.cloudfront.net/security=policy:eyJleHBpcnkiOjQ1MzQ5NDkzNDMsImNhbGwiOlsicmVhZCIsImNvbnZlcnQiXSwiaGFuZGxlIjoiaDVZUWhFcnFSZjZTR3FPNnRzV1kifQ==,signature:4b3a3266bac621e9041b83f3d20d02663374994866c4a02cca60916c1eda3cd9/resize=w:45,h:45,fit:crop/cache=expiry:max/rotate=exif:true/h5YQhErqRf6SGqO6tsWY\",\n    \"default_image_url_large\":\"https://d8g9nhlfs6lwh.cloudfront.net/security=policy:eyJleHBpcnkiOjQ1MzQ5NDkzNDMsImNhbGwiOlsicmVhZCIsImNvbnZlcnQiXSwiaGFuZGxlIjoiaDVZUWhFcnFSZjZTR3FPNnRzV1kifQ==,signature:4b3a3266bac621e9041b83f3d20d02663374994866c4a02cca60916c1eda3cd9/resize=w:450,fit:scale/cache=expiry:max/rotate=exif:true/h5YQhErqRf6SGqO6tsWY\",\n    \"driver\":{\n      \"id\":148954,\n      \"first_name\":\"Andy\",\n      \"last_name\":\"Tonners\",\n      \"full_name\":\"Andy Tonners\",\n      \"default_image_url\":\"https://d8g9nhlfs6lwh.cloudfront.net/MGE87iykQTSXsRHavpyK\"\n    },\n    \"specs\":{\n      \"id\":1124017,\n      \"vehicle_id\":1051653,\n      \"account_id\":18,\n      \"body_type\":\"SUV\",\n      \"body_subtype\":\"\",\n      \"drive_type\":\"4X4\",\n      \"brake_system\":\"Hydraulic\",\n      \"msrp_cents\":3587000,\n      \"fuel_tank_capacity\":21.0,\n      \"fuel_tank_2_capacity\":null,\n      \"front_track_width\":67.7,\n      \"ground_clearance\":8.0,\n      \"height\":72.7,\n      \"length\":190.9,\n      \"rear_track_width\":67.5,\n      \"width\":78.5,\n      \"wheelbase\":109.2,\n      \"front_tire_psi\":null,\n      \"rear_tire_psi\":null,\n      \"base_towing_capacity\":4500.0,\n      \"curb_weight\":4544.0,\n      \"gross_vehicle_weight_rating\":6096.0,\n      \"bed_length\":null,\n      \"max_payload\":1552.0,\n      \"rear_axle_type\":\"\",\n      \"front_tire_type\":\"P245/65R17\",\n      \"front_wheel_diameter\":\"17.0 x 7.5\",\n      \"rear_tire_type\":\"P245/65R17\",\n      \"rear_wheel_diameter\":\"17.0 x 7.5\",\n      \"epa_city\":16.0,\n      \"epa_highway\":22.0,\n      \"epa_combined\":18.0,\n      \"engine_description\":\"3.5L V6 250hp 253ft. lbs.\",\n      \"engine_brand\":\"\",\n      \"engine_aspiration\":\"Naturally Aspirated\",\n      \"engine_block_type\":\"V\",\n      \"engine_bore\":3.5,\n      \"engine_cam_type\":\"SOHC\",\n      \"engine_compression\":10.5,\n      \"engine_cylinders\":6,\n      \"engine_displacement\":3.5,\n      \"fuel_induction\":\"Sequential Multiport Fuel Injection\",\n      \"fuel_quality\":\"87\",\n      \"max_hp\":250,\n      \"max_torque\":253,\n      \"oil_capacity\":5.3,\n      \"redline_rpm\":\"6300\",\n      \"engine_stroke\":3.66,\n      \"engine_valves\":24,\n      \"transmission_description\":\"5-Speed Automatic\",\n      \"transmission_brand\":\"\",\n      \"transmission_type\":\"Automatic\",\n      \"transmission_gears\":5,\n      \"cargo_volume\":18.0,\n      \"interior_volume\":null,\n      \"passenger_volume\":\"152.7\",\n      \"created_at\":\"2020-09-11T14:27:31.151-05:00\",\n      \"updated_at\":\"2020-09-11T14:27:31.151-05:00\",\n      \"duty_type\":null,\n      \"weight_class\":null,\n      \"engine_bore_with_units\":\"3.5 in\",\n      \"wheelbase_with_units\":\"109.2 in\",\n      \"msrp\":35870.0\n    },\n    \"external_ids\":{\n      \"fuel_id\":\"1132-A\",\n      \"task_code\":null,\n    },\n    \"ai_enabled\":false\n  },\n  ...\n]","name":""}]},"settings":"","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"/vehicles","type":"endpoint","slug":"vehicles","excerpt":"Returns a list of your vehicles. Defaults to only returning non-archived vehicles, but you can include archived vehicles in the results as well.","body":"","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54f8de4f4339bb1900c8c007","__v":12,"createdAt":"2015-01-30T21:55:39.880Z","parentDoc":null,"project":"54c0e51215af820d001a38a6","githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["54f8de4f4339bb1900c8c006","54f8de4f4339bb1900c8c007","54f8de4f4339bb1900c8c008","54f8de4f4339bb1900c8c009","54f8de4f4339bb1900c8c00a","558c6c4aee884b19006b2634","558c6c599651c22300361487"],"title":"Vehicles","slug":"vehicles","order":31,"from_sync":false,"reference":true,"_id":"54f8de4e4339bb1900c8bffd","project":"54c0e51215af820d001a38a6","createdAt":"2015-01-30T16:06:34.071Z","version":"54f8de4e4339bb1900c8bffb","__v":3},"user":"54cba76f6d1eee0d00c33dee","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979","5ec5a01754009700689296af"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":40}}

get/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.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

include_archived:
string0
Flag to include archived vehicles in the results.

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}