Vehicles
Learn about the /vehicles endpoint.
Vehicle objects contain vehicle information within a particular payroll account that the user has connected via Argyle Link.
#The vehicle object
- #idstring (uuid)
Unique ID of the vehicle associated with a user's payroll account.
- #accountstring (uuid)
ID of the payroll account associated with the vehicle.
- #employerstring
The name of the company or entity that employs the user.
- #vinstring
Vehicle Identification Number (VIN).
- #makestring
The make or brand of the vehicle manufacturer—for example, Ford, Toyota.
- #modelstring
The model of the vehicle—for example, Fiesta, Prius.
- #yearstring
The manufacture year of the vehicle—for example, 2011.
- #identificationstring
The license plate or other ID depending on the vehicle type.
- #typestring (enum)
The vehicle type.
- #type_description *DEPRECATEDstring
Deprecated in favor of
type(see above). - #created_atstring (timestamp)
Time at which the vehicle object was created. Timestamps follow the ISO 8601 standard.
- #updated_atstring (timestamp)
Time at which the vehicle object was last updated. Timestamps follow the ISO 8601 standard.
- #metadataobject
Holds additional available, often unstructured information about this data resource.
1{
2 "id": "e8b085d1-fa2c-4e0f-8b2e-93c6ac991f12",
3 "account": "010db8b4-a724-47fc-c17e-733b656312a1",
4 "employer": "uber",
5 "vin": "3VWRA81H7WM116221",
6 "make": "Toyota",
7 "model": "Corolla",
8 "year": 2011,
9 "identification": "HIJ8473",
10 "type": "car",
11 "created_at": "2019-04-01T14:13:47.804149Z",
12 "updated_at": "2019-04-02T08:15:15.635636Z",
13 "metadata": {}
14}#Retrieve a vehicle
- Retrieve a vehicle object with the supplied ID.
- This request returns a vehicle object if you provided a valid identifier.
- #idstring (uuid)required
The identifier of the vehicle to be retrieved.
1curl --request GET \
2 --url https://api.argyle.com/v1/vehicles/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1{
2 "id": "01805174-1b04-8e9e-a00e-adc9295df9fc",
3 "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
4 "identification": "D0VGRM",
5 "make": "Ford",
6 "model": "Explorer",
7 "type": "car",
8 "type_description": null,
9 "year": 1995,
10 "vin": "1U33546M4YYT0FXCV",
11 "employer": "udre",
12 "created_at": "2022-04-22T13:26:45.253586Z",
13 "updated_at": "2022-04-22T13:26:45.253641Z",
14 "metadata": {}
15}#List vehicles
- List all vehicles.
- This request returns an object with a
resultsproperty that contains an array of up tolimitvehicle objects.
1curl --request GET \
2 --url https://api.argyle.com/v1/vehicles?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1[
2 {
3 "id": "01805174-1b04-8e9e-a00e-adc9295df9fc",
4 "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
5 "identification": "D0VGRM",
6 "make": "Ford",
7 "model": "Explorer",
8 "type": "car",
9 "type_description": null,
10 "year": 1995,
11 "vin": "1U33546M4YYT0FXCV",
12 "employer": "udre",
13 "metadata": {},
14 "created_at": "2022-04-22T13:26:45.253586Z",
15 "updated_at": "2022-04-22T13:26:45.253641Z"
16 },
17 {
18 "id": "01805174-1ab0-8fe0-d60f-be8f205194d6",
19 "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
20 "identification": "PVIXIS",
21 "make": "Ford",
22 "model": "Galaxy",
23 "type": "car",
24 "type_description": null,
25 "year": 2005,
26 "vin": "18IMWASXATWBW2XE4",
27 "employer": "udre",
28 "metadata": {},
29 "created_at": "2022-04-22T13:26:45.168863Z",
30 "updated_at": "2022-04-22T13:26:45.168929Z"
31 }
32]