---
title: "List leads"
method: GET
path: "/dealerships/{dealershipId}/leads"
tags: ["leads"]
---

# List leads

`GET /dealerships/{dealershipId}/leads`

## Request

- Base URL: `https://api.fullpath.com/consent-management`
- URL: `https://api.fullpath.com/consent-management/dealerships/{dealershipId}/leads`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fullpath/apis/fullpath-api-v1-openapi-3-0/docs/dealerships/:dealershipId/leads/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a paginated list of leads with optional filtering

## Path parameters

- `dealershipId` integer, required

## Query parameters

- `from_date` string, date
- `to_date` string, date
- `status` 'new' | 'contacted' | 'qualified' | 'converted' | 'lost'
- `page` integer
- `per_page` integer
- `sort` string

## Response `200`

A paginated list of leads

- LeadsResponse: Response containing multiple leads with pagination info
  - `data` Lead[], required
    - `id` integer, required: Unique lead identifier
    - `created_at` string, date-time, required: ISO 8601 creation timestamp
    - `crm_lead_id` string, nullable: CRM lead identifier
    - `crm_customer` string, nullable: CRM customer identifier
    - `vehicle_canonical_details` object, nullable: Vehicle canonical details
    - `first_name` string, nullable: First name
    - `middle_name` string, nullable: Middle name
    - `last_name` string, nullable: Last name
    - `main_email_addresses` string, nullable: Main email address
    - `alternative_email_addresses` string, nullable: Alternative email addresses
    - `cell_phone` string, nullable: Cell phone number
    - `home_phone` string, nullable: Home phone number
    - `work_phone` string, nullable: Work phone number
    - `additional_phone_numbers` string, nullable: Additional phone numbers
    - `address` string, nullable: Street address
    - `city` string, nullable: City
    - `state` string, nullable: State abbreviation
    - `zipcode` string, nullable: ZIP code
    - `date_entered` string, date, nullable: Date entered (YYYY-MM-DD)
    - `up_type` string, nullable: UP type
    - `source` string, nullable: Lead source
    - `sub_source` string, nullable: Sub source
    - `status` string, nullable: Lead status
    - `assigned_salesperson` string, nullable: Assigned salesperson name
    - `voi_condition` string, nullable: Vehicle of interest condition
    - `voi_year` string, nullable: Vehicle of interest year
    - `voi_make` string, nullable: Vehicle of interest make
    - `voi_model` string, nullable: Vehicle of interest model
    - `voi_trim` string, nullable: Vehicle of interest trim
    - `voi_sku` string, nullable: Vehicle of interest SKU
    - `voi_vin` string, nullable: Vehicle of interest VIN
    - `voi_miles` string, nullable: Vehicle of interest miles
    - `interested_in_trade_in` boolean, nullable: Whether interested in trade-in
    - `trade_in_vehicle` string, nullable: Trade-in vehicle information
    - `trade_in_year` string, nullable: Trade-in vehicle year
    - `trade_in_make` string, nullable: Trade-in vehicle make
    - `trade_in_model` string, nullable: Trade-in vehicle model
    - `trade_in_trim` string, nullable: Trade-in vehicle trim
    - `trade_in_estimation` string, nullable: Trade-in estimation
    - `is_sold` boolean, nullable: Whether the lead is sold
    - `still_owns` boolean, nullable: Whether the customer still owns the vehicle
    - `sale_date` string, date, nullable: Sale date (YYYY-MM-DD)
    - `sold_vehicle_condition` string, nullable: Sold vehicle condition
    - `sold_vehicle_year` string, nullable: Sold vehicle year
    - `sold_vehicle_make` string, nullable: Sold vehicle make
    - `sold_vehicle_model` string, nullable: Sold vehicle model
    - `sold_vehicle_trim` string, nullable: Sold vehicle trim
    - `sold_vehicle_sku` string, nullable: Sold vehicle SKU
    - `sold_vehicle_vin` string, nullable: Sold vehicle VIN
    - `sold_vehicle_price` number, nullable: Sold vehicle price
    - `front_gross` number, nullable: Front gross amount
    - `back_gross` number, nullable: Back gross amount
    - `total_gross` number, nullable: Total gross amount
    - `vehicle_images` string[]: Array of vehicle image URLs
    - `push_to_crm` boolean, nullable: Whether to push to CRM
    - `sale_term` string, nullable: Sale term
    - `purchase_type` string, nullable: Purchase type
  - `pagination` Pagination, required: Pagination metadata
    - `page` integer, required: Current page number (1-based)
    - `per_page` integer, required: Number of items per page
    - `total` integer, required: Total number of items
    - `total_pages` integer, required: Total number of pages

## Other responses

- `204`: No leads found
- `400`: Invalid query parameters
- `401`: Unauthorized
- `500`: Server error

---

[API](https://skmtc.dev/fullpath/apis/fullpath-api-v1-openapi-3-0.md) - [All operations](https://skmtc.dev/fullpath/apis/fullpath-api-v1-openapi-3-0/llms.txt) - [OpenAPI document](https://skmtc.dev/fullpath/apis/fullpath-api-v1-openapi-3-0/revisions/4b73e1835a7e?raw)