Vehicles

Work vehicle information.

#The vehicle object

Attributes
  • #
    idstring (uuid)

    Unique ID of the vehicle.

  • #
    accountstring (uuid)

    ID of the account associated with the vehicle.

  • #
    identificationstring

    License plate number or similar vehicle identifier.

  • #
    makestring

    Vehicle brand or manufacturer.

  • #
    modelstring

    Vehicle model.

  • #
    typestring (enum)

    The type of vehicle.

  • #
    yearstring

    Year the vehicle was made.

  • #
    vinstring

    Vehicle Identification Number (VIN).

  • #
    employerstring

    Name of the user's employer.

  • #
    created_atstring (datetime)

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

  • #
    updated_atstring (datetime)

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

  • #
    metadataobject

    Additional, non-categorized information.

Example
1{
2  "id": "01763a69-5cbe-2edb-ade1-5591157c354d",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "identification": "AEWUQ7",
5  "make": "Ford",
6  "model": "Mondeo",
7  "type": "car",
8  "year": 1998,
9  "vin": "QUICELDKTRQJ4S33C",
10  "employer": "GigAndGo",
11  "created_at": "2023-02-09T13:42:03.966Z",
12  "updated_at": "2023-02-09T13:42:03.966Z",
13  "metadata": {}
14}

#Retrieve a vehicle

get/v2/vehicles/{id}

Retrieves a vehicle object.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the vehicle object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/vehicles/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "01763a69-5cbe-2edb-ade1-5591157c354d",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "identification": "AEWUQ7",
5  "make": "Ford",
6  "model": "Mondeo",
7  "type": "car",
8  "year": 1998,
9  "vin": "QUICELDKTRQJ4S33C",
10  "employer": "GigAndGo",
11  "created_at": "2023-02-09T13:42:03.966Z",
12  "updated_at": "2023-02-09T13:42:03.966Z",
13  "metadata": {}
14}

#List all vehicles

get/v2/vehicles

Returns an array of all vehicle objects.

Query parameters
  • #
    accountstring (uuid)
    optional

    Filter by account ID.

  • #
    userstring (uuid)
    optional

    Filter by user ID.

  • #
    limitinteger
    optional

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

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/vehicles?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "0176364c-c8a2-4d43-2a12-7b4146a829a9",
4    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
5    "identification": "JASJ1Y",
6    "make": "Ford",
7    "model": "Focus",
8    "type": "car",
9    "year": 2011,
10    "vin": "W081C4YIZQYE55DSE",
11    "employer": "GigAntic",
12    "created_at": "2023-02-09T13:28:11.427Z",
13    "updated_at": "2023-02-09T13:32:13.215Z",
14    "metadata": {
15      "source": "gig platform"
16    }
17  },
18  {
19    "id": "01763a69-5cbe-2edb-ade1-5591157c354d",
20    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
21    "identification": "AEWUQ7",
22    "make": "Ford",
23    "model": "Mondeo",
24    "type": "car",
25    "year": 1998,
26    "vin": "QUICELDKTRQJ4S33C",
27    "employer": "GigAndGo",
28    "created_at": "2023-02-09T13:42:03.966Z",
29    "updated_at": "2023-02-09T13:42:03.966Z",
30    "metadata": {}
31  }
32]
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com