---
title: "List sales leads"
method: GET
path: "/sales_leads"
tags: ["Sales Leads"]
---

# List sales leads

`GET /sales_leads`

## Request

- Base URL: `https://api.shopvox.com/v1`
- URL: `https://api.shopvox.com/v1/sales_leads`
- Auth: API key in query parameter `account_id` and API key in query parameter `authToken`
- TypeScript: <https://skmtc.dev/shopvox/apis/shopvox-public-api/docs/sales_leads/get.ts> (a function with typed inputs; its response is checked against the schema)

**Plan: Paid API.**

## Query parameters

- `active` boolean
- `page` integer
- `per_page` integer

## Response `200`

OK

- object
  - `stats` PaginationStats: Pagination metadata attached as `stats` (or `meta` on assets) to index responses. The **quotes** list uses a different block - see `QuoteListStats`.
    - `totalCount` integer
    - `page` integer
    - `perPage` integer
    - `totalPages` integer
    - `prevPage` integer, nullable
    - `nextPage` integer, nullable
    - `outOfRange` boolean
  - `salesLeads` SalesLead[]
    - `id` string, uuid
    - `title` string
    - `details` string, nullable
    - `workflowState` string, nullable
    - `nextContactDate` string, date, nullable
    - `expectedCloseDate` string, date, nullable
    - `qualified` boolean, nullable
    - `dealValueInDollars` number, nullable: US dollars.
    - `createdAt` string, date-time
    - `createdById` string, uuid, nullable
    - `updatedById` string, uuid, nullable
    - `companyId` string, uuid, nullable
    - `company` NamedRef: Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `leadSourceId` string, uuid, nullable
    - `leadSource` NamedRef: Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `salesRepId` string, uuid, nullable
    - `salesRep` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `pipelineStageId` string, uuid, nullable
    - `pipelineStage` NamedRef: Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `primaryContactId` string, uuid, nullable
    - `primaryContact` object
      - `id` string, uuid
      - `name` string
      - `email` string, nullable
    - `pipelineId` string, uuid, nullable
    - `pipeline` object
      - `id` string, uuid
      - `name` string
      - `stages` object[]
        - `id` string, uuid
        - `name` string
        - `position` integer
    - `assignedToId` string, uuid, nullable
    - `assignedTo` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `divisionId` string, uuid, nullable
    - `division` object: Full division record (all columns), present only when the lead has a division.

## Other responses

- `401`: Missing/expired credentials, an index request without a required filter, or the plan does not include this endpoint.

## Changes

- **2026-09-24** `9a4659d3b0c1`: 1 info
  - added the new optional `query` request parameter `active`

[Operation history](https://skmtc.dev/shopvox/apis/shopvox-public-api/changes/sales_leads/get.md)

---

[API](https://skmtc.dev/shopvox/apis/shopvox-public-api.md) - [All operations](https://skmtc.dev/shopvox/apis/shopvox-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shopvox/apis/shopvox-public-api/revisions/c02128f70b33?raw)