Learn about the /vehicles endpoint.
Vehicle objects contain vehicle information within a particular payroll account that the user has connected via Argyle Link.
Attributes
| Attribute | Type | Description |
|---|---|---|
| id | string uuid | Unique ID of the vehicle associated with a user's payroll account. |
| account | string uuid | ID of the payroll account associated with the vehicle. |
| employer | string | The name of the company or entity that employs the user. |
| vin | string | Vehicle Identification Number (VIN). |
| make | string | The make or brand of the vehicle manufacturer—for example, Ford, Toyota. |
| model | string | The model of the vehicle—for example, Fiesta, Prius. |
| year | integer | The manufacture year of the vehicle—for example, 2011. |
| identification | string | The license plate or other ID depending on the vehicle type. |
| type | string | The vehicle type. Possible values: car, pedestrian, ebike, bicycle, scooter, motorcycle, other. |
| type_description *deprecated | string | Deprecated in favor of /vehicles.type |
| metadata | object | Metadata holds additional available, often unstructured, information about this data resource. |
| created_at | string timestamp | Time at which the vehicle object was created. Timestamps follow the ISO 8601 standard. |
| updated_at | string timestamp | Time at which the vehicle object was last updated. Timestamps follow the ISO 8601 standard. |
Endpoints
These are the endpoints available for vehicles.
| Endpoints |
|---|
Retrieve a vehicle - GET /vehicles/:id |
List vehicles - GET /vehicles |
Example object
{
"id": "e8b085d1-fa2c-4e0f-8b2e-93c6ac991f12",
"account": "010db8b4-a724-47fc-c17e-733b656312a1",
"employer": "uber",
"created_at": "2019-04-01T14:13:47.804149Z",
"updated_at": "2019-04-02T08:15:15.635636Z",
"vin": "3VWRA81H7WM116221",
"make": "Toyota",
"model": "Corolla",
"year": 2011,
"identification": "HIJ8473",
"type": "car",
"metadata": {}
}