List inventory

List vehicles

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/inventory \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/inventory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "86b8c4e0-f57b-48c7-974d-4c45fbac2aed",
      "vin": "1C4HJXEG5NW195712",
      "year": 2022,
      "make": "Jeep",
      "model": "Wrangler Unlimited",
      "trim": "Sport",
      "vehicle_type": "Used",
      "price": 27759,
      "mileage": 45225,
      "exterior_color": "Bright White Clearcoat",
      "exterior_color_code": "PW7",
      "color_family": "White",
      "interior_color": "Black",
      "body_style": "SUV",
      "drivetrain": "4WD",
      "transmission": "Automatic",
      "fuel_type": "Gasoline",
      "certified": false,
      "instock_date": "2026-04-01T00:00:00+00:00",
      "days_on_lot": 115,
      "photo_count": 24,
      "has_description": true,
      "stock_number": "U17968I",
      "status": null,
      "photo_url": "https://cdnrs.inventoryrsc.com/640x480/490008540_697aded63b109513bccc1573.jpg",
      "updated_at": "2026-02-28T09:02:26.966306+00:00"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJzb3J0IjoidmluX2FzYyIsInZpbiI6IjFDNFJESkRHOVBDNjAzMTkxIn0=",
    "total_count": 254
  }
}

GET

inventory

List vehicles

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/inventory \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/inventory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "86b8c4e0-f57b-48c7-974d-4c45fbac2aed",
      "vin": "1C4HJXEG5NW195712",
      "year": 2022,
      "make": "Jeep",
      "model": "Wrangler Unlimited",
      "trim": "Sport",
      "vehicle_type": "Used",
      "price": 27759,
      "mileage": 45225,
      "exterior_color": "Bright White Clearcoat",
      "exterior_color_code": "PW7",
      "color_family": "White",
      "interior_color": "Black",
      "body_style": "SUV",
      "drivetrain": "4WD",
      "transmission": "Automatic",
      "fuel_type": "Gasoline",
      "certified": false,
      "instock_date": "2026-04-01T00:00:00+00:00",
      "days_on_lot": 115,
      "photo_count": 24,
      "has_description": true,
      "stock_number": "U17968I",
      "status": null,
      "photo_url": "https://cdnrs.inventoryrsc.com/640x480/490008540_697aded63b109513bccc1573.jpg",
      "updated_at": "2026-02-28T09:02:26.966306+00:00"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJzb3J0IjoidmluX2FzYyIsInZpbiI6IjFDNFJESkRHOVBDNjAzMTkxIn0=",
    "total_count": 254
  }
}

Returns a paginated list of vehicles from the dealership’s current inventory. Scope required: inventory:read

Query parameters

integer

default:"25"

Results per page (1-100).

string

Opaque keyset pagination cursor (includes active sort).

string

Filter by vehicle make (e.g., Chevrolet).

string

Filter by vehicle model (e.g., Silverado).

integer

Filter by exact model year (wins over min_year / max_year).

integer

Minimum model year.

integer

Maximum model year.

string

Filter by vehicle type: New or Used.

number

Minimum list price.

number

Maximum list price.

integer

Minimum mileage.

integer

Maximum mileage.

integer

Minimum days in stock (from instock_date).

integer

Maximum days in stock.

string

Search make, model, stock number, or VIN.

string

Trim substring (metadata post-filter).

boolean

Filter certified / CPO units (true / false).

integer

Minimum photo count (post-filter).

boolean

Filter units with (true) or without (false) a Hrizn AI description.

string

Filter by Hrizn color family (e.g. white, blue). Expands OEM paint names on this site (Ice Cap → white). Prefer this for semantic color search.

string

Filter by OEM exterior paint name (path-scoped substring, e.g. Ocean Gem or ice). Use color_family for generic colors.

string

default:"vin_asc"

Sort: vin_asc, newest, oldest, price_asc, price_desc, mileage_asc, mileage_desc.

Each list item includes browse fields from inventory metadata (trim, colors, body_style, drivetrain/transmission/fuel), derived color_family, age (instock_date, days_on_lot), certified, photo_count, and has_description. Full Hrizn AI copy is not included on list — use Get vehicle for ai_description. pagination.total_count is the full matching set for DB filters (not reduced by the cursor). When trim, certified, or min_photos post-filters are active, total_count reflects the pre post-filter set.

{
  "data": [
    {
      "id": "86b8c4e0-f57b-48c7-974d-4c45fbac2aed",
      "vin": "1C4HJXEG5NW195712",
      "year": 2022,
      "make": "Jeep",
      "model": "Wrangler Unlimited",
      "trim": "Sport",
      "vehicle_type": "Used",
      "price": 27759,
      "mileage": 45225,
      "exterior_color": "Bright White Clearcoat",
      "exterior_color_code": "PW7",
      "color_family": "White",
      "interior_color": "Black",
      "body_style": "SUV",
      "drivetrain": "4WD",
      "transmission": "Automatic",
      "fuel_type": "Gasoline",
      "certified": false,
      "instock_date": "2026-04-01T00:00:00+00:00",
      "days_on_lot": 115,
      "photo_count": 24,
      "has_description": true,
      "stock_number": "U17968I",
      "status": null,
      "photo_url": "https://cdnrs.inventoryrsc.com/640x480/490008540_697aded63b109513bccc1573.jpg",
      "updated_at": "2026-02-28T09:02:26.966306+00:00"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJzb3J0IjoidmluX2FzYyIsInZpbiI6IjFDNFJESkRHOVBDNjAzMTkxIn0=",
    "total_count": 254
  }
}

Authorizations

X-API-Key

string

header

required

Your Hrizn API key (prefix hzk_)

Query Parameters

limit

integer

default:25

Number of results per page

Required range: 1 <= x <= 100

cursor

string

Base64-encoded pagination cursor

make

string

Filter by make (case-insensitive partial match)

model

string

Filter by model (case-insensitive partial match)

year

integer

Filter by exact model year (wins over min_year/max_year)

min_year

integer

Minimum model year

max_year

integer

Maximum model year

vehicle_type

string

Filter by vehicle type (New or Used)

min_price

number

max_price

number

min_mileage

integer

max_mileage

integer

min_days_on_lot

integer

Minimum days in stock (from instock_date)

max_days_on_lot

integer

Maximum days in stock

string

Search make, model, stock number, or VIN

trim

string

certified

enum<string>

Available options:

true,

false

min_photos

integer

has_description

enum<string>

Filter units with or without a Hrizn AI description

Available options:

true,

false

exterior_color

string

Filter by OEM exterior paint name (path-scoped substring against inventory metadata exteriorcolor). For generic colors like white/blue, prefer color_family so OEM names such as Ice Cap are included.

color_family

string

Filter by Hrizn color family (e.g. white, blue, black). Expands to matching OEM paint names/codes observed on this site's inventory (Ice Cap → white). Does not match unrelated metadata text.

sort

enum<string>

default:vin_asc

Available options:

vin_asc,

newest,

oldest,

price_asc,

price_desc,

mileage_asc,

mileage_desc

Response

Paginated list of vehicles

data

object[]

Hide child attributes

data.id

string<uuid>

data.vin

string

data.year

integer

data.make

string

data.model

string

data.trim

string | null

data.vehicle_type

string

Vehicle condition (new or used)

data.price

number | null

data.mileage

integer | null

data.exterior_color

string | null

data.exterior_color_code

string | null

data.color_family

string | null

Hrizn-derived color family for the dealer OEM exterior paint (e.g. White, Blue). Not a re-export of licensed provider rows.

data.interior_color

string | null

data.body_style

string | null

data.drivetrain

string | null

data.transmission

string | null

data.fuel_type

string | null

data.certified

boolean

data.instock_date

string<date-time> | null

data.days_on_lot

integer | null

data.photo_count

integer

data.has_description

boolean

True when a Hrizn AI description has been generated

data.stock_number

string | null

data.status

string | null

data.photo_url

string | null

data.updated_at

string<date-time>

pagination

object

Hide child attributes

pagination.has_more

boolean

pagination.next_cursor

string | null

pagination.total_count

integer

Last modified on July 26, 2026

Overview

IdeaClouds

Content Intelligence

Content

Content Types

Compliance

Content Tools

Inventory

Market

Site

Dealership Config

Social

Webhooks

Reference

Health

IdeaClouds

Content

Compliance

Content Tools

Inventory

Market

Site

Webhooks

Content Intelligence

Reference

Social

Query parameters

Authorizations

Query Parameters

Response

​Query parameters

Authorizations

Query Parameters

Response

Query parameters