---
title: "List deals"
method: GET
path: "/deals"
tags: ["Deals"]
---

# List deals

`GET /deals`

## Request

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

Returns a paginated list of deals. 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 deal title
- `pipelineId` string: Filter by pipeline public ID
- `stageId` string: Filter by stage public ID
- `status` 'ACTIVE' | 'WON' | 'LOST': Filter by deal status (ACTIVE, WON, LOST)

## Response `200`

OK

- object
  - `items` object[], required
    - `id` string, required: Deal public ID
    - `number` string, nullable: Auto-generated deal number
    - `title` string, required: Deal title
    - `price` number, nullable: Deal price/value
    - `status` string, nullable: Deal status
    - `priority` string, nullable: Deal priority
    - `expectedCloseDate` string, date-time, nullable: Expected close date
    - `clientId` string, nullable: Client public ID
    - `pipelineId` string, nullable: Pipeline public ID
    - `stageId` string, nullable: Pipeline stage public ID
    - `sourceId` string, nullable: Deal source public ID
    - `leadId` string, nullable: Lead public ID
    - `createdAt` string, date-time, required: When the deal 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)