Skip to main content
GET
/
v2
/
vehicles
List all vehicles
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/vehicles \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "0176364c-c8a2-4d43-2a12-7b4146a829a9",
    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
    "identification": "JASJ1Y",
    "make": "Ford",
    "model": "Focus",
    "type": "car",
    "year": 2011,
    "vin": "W081C4YIZQYE55DSE",
    "employer": "GigAntic",
    "created_at": "2023-02-09T13:28:11.427Z",
    "updated_at": "2023-02-09T13:32:13.215Z",
    "metadata": {
      "source": "gig platform"
    }
  },
  {
    "id": "01763a69-5cbe-2edb-ade1-5591157c354d",
    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
    "identification": "AEWUQ7",
    "make": "Ford",
    "model": "Mondeo",
    "type": "car",
    "year": 1998,
    "vin": "QUICELDKTRQJ4S33C",
    "employer": "GigAndGo",
    "created_at": "2023-02-09T13:42:03.966Z",
    "updated_at": "2023-02-09T13:42:03.966Z",
    "metadata": {}
  }
]

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

​
account
string<uuid>

Filter by account ID.

​
user
string<uuid>

Filter by user ID.

​
limit
integer

Number of vehicle objects returned per page. Default: 10. Maximum: 200.

Response

200 - application/json
​
id
string<uuid>

Unique ID of the vehicle.

​
account
string<uuid>

ID of the account associated with the vehicle.

​
identification
string

License plate number or similar vehicle identifier.

​
make
string

Vehicle brand or manufacturer.

​
model
string

Vehicle model.

​
type
enum<string>

The type of vehicle.

Available options:
car,
pedestrian,
ebike,
bicycle,
scooter,
motorcycle,
other
​
year
string

Year the vehicle was made.

​
vin
string

Vehicle Identification Number (VIN).

​
employer
string

Name of the user's employer.

​
created_at
string<datetime>

Timestamp (ISO 8601) when the vehicle object was created.

​
updated_at
string<datetime>

Timestamp (ISO 8601) when a property value of the vehicle object most recently changed.

​
metadata
object

Additional, non-categorized information.