> ## Documentation Index
> Fetch the complete documentation index at: https://developers.superiorvan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started

> How vendors connect to Superior Van & Mobility through the Partner API

## About Superior Van & Mobility

Superior Van & Mobility is the nation's largest family-owned mobility dealer, known for accessible vans, lifts, and adaptive driving equipment backed by nationwide service and support. The Partner API lets vendors securely share lead information so Superior Van teams can respond quickly and keep both systems in sync.

## What the Partner API is for

* Send new lead information captured in your apps or forms.
* Create or match a HubSpot contact by email or phone.
* Create a Superior Van deal with vendor notes, lead type, and optional vehicle details.
* Retrieve the current vendor-facing status for submitted leads.

## How it works

* Vendors send leads as JSON to Superior Van via HTTPS.
* Each vendor receives an API key. Include `x-api-key: <your-api-key>` on every request.
* Responses include a `leadId` you can use to check status updates.

## Access and authentication

1. Request an API key from the Superior Van partner team.
2. Use the base URL for your environment:
   * Production: `https://api.superiorvan.com/v1`
   * Sandbox: `https://sandbox.superiorvan.com/v1`
3. Send the header `x-api-key: <your key>` with every call.

## Typical vendor flow

1. Capture a lead in your system.
2. Call **Create Lead** with `first_name`, `deal_type`, `vendor_name`, `lead_notes`, and either a valid `email` or valid `phone`.
3. Use **Get Lead** with the returned `leadId` to see current status.

Use the Quickstart to send your first request, then explore the API Reference for details and examples.
