Skip to main content

Using External IDs in Place of IDs

It is possible to use an External ID in place of the Fleetio Vehicle ID in the URL path for Vehicle specific endpoints.

To use this feature, you must first configure External IDs in your account settings, and assign one or more Vehicles an External ID. Our External Vehicle IDs guide contains information on how to configure External IDs.

Once your External IDs have been configured, you can use them to query the API by replacing the Fleetio ID with a key:value pair that corresponds to your registered External ID. You will still be able to send requests using the default Fleetio Vehicle ID syntax eg; https://secure.fleetio.com/api/v1/vehicles/123

Some examples of using External IDs in place of IDs:

  • https://secure.fleetio.com/api/v1/vehicles/accounting_id:987

  • https://secure.fleetio.com/api/v1/vehicles/456/restore could become https://secure.fleetio.com/api/v1/vehicles/vin:A12B34C56D78/restore