Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
mileage
/
vehicles
List vehicles
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/vehicles \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "make_and_model": "<string>",
      "year": 123,
      "is_primary": true,
      "is_eligible_for_deletion": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "com.layerfi.routers.ApiVehicle",
      "external_id": "<string>",
      "license_plate": "<string>",
      "vin": "<string>",
      "description": "<string>",
      "archived_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business.

Query Parameters

​
allow_archived
boolean
default:false

Include archived vehicles in the response.

​
allow_deleted
boolean
default:false

Include deleted vehicles in the response.

Response

List of vehicles.

​
data
object[]
required