Vehicle Object - Asset API Documentation

business_id

string<biz_string>

required

The id of the Business that owns the vehicle

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

description

string

required

A human-readable description of the vehicle

Maximum string length: 255

Example:

"2019 Ford F-150"

make

string | null

required

The make of the vehicle

Example:

"Ford"

model

string | null

required

The model of the vehicle

Example:

"F-150"

license_plate

string | null

required

The license plate of the vehicle

Example:

"ABC-1234"

vin

string | null

required

The Vehicle Identification Number

Example:

"1FTEW1EP5KFA12345"

id

string<vhc_string>

required

The id of the Vehicle

Example:

"vhc_GA6EG2qFxA97NZHtxeLPUy"

external_id

string | null

The external ID of the Vehicle

Maximum string length: 255

Example:

"1234567890"

year

integer | null

The model year of the vehicle

Example:

2019

is_active

boolean

default:true

Whether the vehicle is active

Example:

true

List vehicles for a business**Scopes:** `vehicle:read`

⌘I

{
  "business_id": "<string>",
  "description": "<string>",
  "make": "Ford",
  "model": "F-150",
  "license_plate": "ABC-1234",
  "vin": "1FTEW1EP5KFA12345",
  "id": "<string>",
  "external_id": "1234567890",
  "year": 2019,
  "is_active": true
}