Vehicles

List vehicles

The location's vehicles, oldest first, one page at a time. To find one, filter on its registration number or your own reference.

get/v1/locations/{locationId}/vehicles

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/vehicles
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Query parameters

registrationNumberstring

Only vehicles with exactly this registration number.

externalReferencestring

Only the vehicle you created with this externalReference.

limitinteger

Page size, 1 to 200. Default 50.

afterstring

The nextCursor of the previous page.

Response

OK

nextCursorstring

Pass as after to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "colour": "Red",
      "description": "The red van",
      "externalReference": "crm-88121",
      "id": "veh_3Ks7pQx2Wn9Tb4Vd6HyRcE",
      "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
      "make": "Volvo",
      "model": "V60",
      "modelYear": 2021,
      "registrationNumber": "ABC123"
    }
  ],
  "nextCursor": "veh_3Ks7pQx2Wn9Tb4Vd6HyRcE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.