{"_id":"5a6a3813a6fb13005d21a50b","project":"54c0e51215af820d001a38a6","version":{"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","forked_from":"54f8de14c6cabe23005c02a2","__v":33,"createdAt":"2015-03-05T22:53:02.044Z","releaseDate":"2015-03-05T22:53:02.044Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"54f8de4e4339bb1900c8bffd","project":"54c0e51215af820d001a38a6","pages":["54f8de4f4339bb1900c8c006","54f8de4f4339bb1900c8c007","54f8de4f4339bb1900c8c008","54f8de4f4339bb1900c8c009","54f8de4f4339bb1900c8c00a","558c6c4aee884b19006b2634","558c6c599651c22300361487"],"version":"54f8de4e4339bb1900c8bffb","__v":3,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-01-30T16:06:34.071Z","from_sync":false,"order":4,"slug":"vehicles","title":"Vehicles"},"user":"54cba76f6d1eee0d00c33dee","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-01-25T20:03:31.940Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":9,"body":"[block:api-header]\n{\n  \"title\": \"Using External IDs in Place of IDs\"\n}\n[/block]\nIt's possible to query use an external id in place of the Fleetio id for any action where the id is required (`vehicles/:id`, `vehicles/:id/archive`, etc). To do this you should first create an external id for your account and assign ids to your vehicles. This can currently only be done through our UI.\n\nOnce your external ids have been setup you can use it to query the API. You simply replace Fleetio's id with a key/value pair for your external id. Some examples:\n\n`https://secure.fleetio.com/api/v1/vehicles/123` becomes `https://secure.fleetio.com/api/v1/vehicles/accounting_id:987`\n\n`https://secure.fleetio.com/api/v1/vehicles/456/restore` becomes `https://secure.fleetio.com/api/v1/vehicles/vin:ABCDEFGH123456789`\n\n`accounting_id` and `vin` in the above examples refer to the keys that are auto generated from your external id.","excerpt":"","slug":"vehicle-external-ids","type":"basic","title":"External IDs"}
[block:api-header] { "title": "Using External IDs in Place of IDs" } [/block] It's possible to query use an external id in place of the Fleetio id for any action where the id is required (`vehicles/:id`, `vehicles/:id/archive`, etc). To do this you should first create an external id for your account and assign ids to your vehicles. This can currently only be done through our UI. Once your external ids have been setup you can use it to query the API. You simply replace Fleetio's id with a key/value pair for your external id. Some examples: `https://secure.fleetio.com/api/v1/vehicles/123` becomes `https://secure.fleetio.com/api/v1/vehicles/accounting_id:987` `https://secure.fleetio.com/api/v1/vehicles/456/restore` becomes `https://secure.fleetio.com/api/v1/vehicles/vin:ABCDEFGH123456789` `accounting_id` and `vin` in the above examples refer to the keys that are auto generated from your external id.