---
title: "This OpenAPI document"
method: GET
path: "/v1/openapi.json"
tags: ["Discovery"]
---

# This OpenAPI document

`GET /v1/openapi.json`

## Request

- Base URL: `https://api.carhandshake.com`
- URL: `https://api.carhandshake.com/v1/openapi.json`
- Auth: none required

## Response `200`

OpenAPI 3.1 document

- OpenApiDocument
  - `openapi` '3.1.0', required
  - `info` object, required
    - `title` string, required
    - `version` string, required
    - `description` string, required
    - `contact` object, required
      - `email` string, email, required
  - `servers` object[], required
    - `url` string, uri, required
  - `security` unknown[], required: The v1 inventory and consented-lead surface is anonymous.
    - unknown
  - `tags` object[], required
    - `name` string, required
    - `description` string, required
  - `paths` object, required
  - `components` object, required
    - `parameters` object, required
    - `responses` object, required
    - `schemas` object, required

---

[API](https://skmtc.dev/carhandshake/apis/car-handshake-inventory-api.md) · [All operations](https://skmtc.dev/carhandshake/apis/car-handshake-inventory-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carhandshake/apis/car-handshake-inventory-api/revisions/0a85bfd1c565?raw)