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

# List leads

`GET /leads`

## Request

- Base URL: `https://api.heffl.com/api/v1`
- URL: `https://api.heffl.com/api/v1/leads`
- Auth: API key in header `x-api-key`

Returns a paginated list of leads. Supports search and filtering.

## Query parameters

- `cursor` string: Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.
- `limit` number: Number of items to return (max 100)
- `search` string: Search by name, email, mobile, or website
- `archived` boolean: Filter by archived status
- `stageId` string: Filter by stage public ID

## Response `200`

OK

- object
  - `items` object[], required
    - `id` string, required: Lead public ID
    - `number` string, required: Auto-generated lead number
    - `name` string, required: Full name
    - `title` string, nullable: Job title
    - `email` string, nullable: Email address
    - `mobile` string, nullable: Mobile phone number
    - `secondaryMobile` string, nullable: Secondary mobile
    - `website` string, nullable: Website URL
    - `value` number, nullable: Expected value
    - `archived` boolean, required: Whether the lead is archived
    - `sourceId` string, nullable: Lead source public ID
    - `stageId` string, nullable: Lead stage public ID
    - `createdAt` string, date-time, required: When the lead was created
    - `customFields` object, nullable: Custom field values
  - `nextCursor` string, nullable: Cursor to fetch the next page. Null if there are no more results.
  - `hasMore` boolean, required: Whether additional results are available

---

[API](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1.md) · [All operations](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/revisions/9bdb229223a2?raw)