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

# List deals

`GET /api/v1/deals`

## Request

- Base URL: `https://mailinapp.com`
- URL: `https://mailinapp.com/api/v1/deals`
- Auth: HTTP bearer

The account's deals across every pipeline, most recently moved first, for deal pickers. Each one carries its contact's address, so a call that returns deals is recorded in the account's data-access log. `truncated` is true when more deals matched than were returned.

## Query parameters

- `pipelineId` string
- `stageId` string
- `status` 'open' | 'won' | 'lost'
- `limit` integer

## Response `200`

The deals

- object
  - `deals` Deal[], required
    - `id` string, required
    - `title` string, required
    - `value` number, required
    - `currency` string, required
    - `pipelineId` string, required
    - `stageId` string, required
    - `stage` string, nullable, required: The stage's name.
    - `status` 'open' | 'won' | 'lost', required
    - `source` 'manual' | 'journey' | 'booking' | 'checkout' | 'proposal' | 'api', required
    - `listId` string, required
    - `rowId` string, required
    - `email` string, email, required
  - `truncated` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key
- `404`: Not found, or not this account's
- `429`: Too many requests for this key

---

[API](https://skmtc.dev/mailinapp/apis/mailinapp-api.md) · [All operations](https://skmtc.dev/mailinapp/apis/mailinapp-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailinapp/apis/mailinapp-api/revisions/61016f797884?raw)