> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hrizn.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List inventory

> List vehicles in this site's inventory

Returns a paginated list of vehicles from the dealership's current inventory.

**Scope required:** `inventory:read`

## Query parameters

<ParamField query="limit" type="integer" default="25">Results per page (1-100).</ParamField>
<ParamField query="cursor" type="string">Pagination cursor.</ParamField>
<ParamField query="make" type="string">Filter by vehicle make (e.g., `Chevrolet`).</ParamField>
<ParamField query="model" type="string">Filter by vehicle model (e.g., `Silverado`).</ParamField>
<ParamField query="year" type="integer">Filter by model year.</ParamField>
<ParamField query="vehicle_type" type="string">Filter by vehicle type: `new` or `used`.</ParamField>

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "data": [
      {
        "id": "86b8c4e0-f57b-48c7-974d-4c45fbac2aed",
        "vin": "1C4HJXEG5NW195712",
        "year": 2022,
        "make": "Jeep",
        "model": "Wrangler Unlimited",
        "vehicle_type": "Used",
        "price": 27759,
        "mileage": 45225,
        "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": "eyJpZCI6IjFDNFJESkRHOVBDNjAzMTkxIn0=",
      "total_count": 254
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /inventory
openapi: 3.1.0
info:
  title: Hrizn Public API
  version: 1.2.0
  description: >
    The Hrizn Public API allows partners to programmatically create content,
    manage inventory descriptions, and integrate with the Hrizn platform.


    All endpoints are prefixed with `/public` and require an API key passed via
    the `X-API-Key` header (except the health check).
  contact:
    email: support@hrizn.io
servers:
  - url: https://api.app.hrizn.io/v1/public
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: IdeaClouds
    description: Create and manage AI-powered keyword research
  - name: Content Intelligence
    description: AI-powered content gap analysis and recommendations
  - name: Content
    description: Generate content from IdeaClouds
  - name: Compliance
    description: Run OEM compliance checks on content
  - name: Content Tools
    description: Generate SEO metadata, schemas, and social snippets
  - name: Inventory
    description: Access vehicle data and AI descriptions
  - name: Site
    description: View dealership details and configuration
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events
  - name: Reference
    description: Look up available types, scopes, and events
  - name: Social
    description: >-
      Zernio-backed social posting and reviews across all connected platforms
      (X, Facebook, Instagram, LinkedIn, Google Business Profile)
  - name: Health
    description: Health check (no authentication)
paths:
  /inventory:
    get:
      tags:
        - Inventory
      summary: List vehicles
      operationId: listInventory
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
        - name: make
          in: query
          schema:
            type: string
          description: Filter by make (case-insensitive partial match)
        - name: model
          in: query
          schema:
            type: string
          description: Filter by model (case-insensitive partial match)
        - name: year
          in: query
          schema:
            type: integer
          description: Filter by exact model year
        - name: vehicle_type
          in: query
          schema:
            type: string
            enum:
              - new
              - used
          description: Filter by vehicle type (new or used)
      responses:
        '200':
          description: Paginated list of vehicles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 100
      description: Number of results per page
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
      description: Base64-encoded pagination cursor
  schemas:
    InventoryListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/VehicleSummary'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    VehicleSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        vin:
          type: string
        year:
          type: integer
        make:
          type: string
        model:
          type: string
        vehicle_type:
          type: string
          description: Vehicle condition (new or used)
        price:
          type: number
          nullable: true
        mileage:
          type: integer
          nullable: true
        stock_number:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        photo_url:
          type: string
          nullable: true
        updated_at:
          type: string
          format: date-time
    PaginationInfo:
      type: object
      properties:
        has_more:
          type: boolean
        next_cursor:
          type: string
          nullable: true
        total_count:
          type: integer
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: 'keyword: Required'
            details:
              type: object
            request_id:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: API key lacks required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````