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

# List deals

`GET /deals`

Returns a paginated list of deals. Supports filtering by deal name, account ID, and status.

## Query parameters

- `page` integer — Page number (1-based)
- `size` integer — Number of items per page
- `name` string — Filter by deal name
- `account_id` integer — Filter by account ID
- `status` 'Open' | 'Closed won' | 'Closed lost' | 'Closed' | 'Deleted' — Filter by deal status (e.g. Open, Closed won, Closed lost)

## Response `200`

Paginated list of deals

- DealListResponse
  - `data` Deal[], required
    - `id` number, required — Deal ID
    - `name` string, required — Deal name
    - `crmId` string, required — External CRM identifier
    - `crmIdentifier` string, nullable, required — External CRM identifier (unified field)
    - `crmLink` string, uri, required — URL to deal in external CRM
    - `crm` 'microsoft_dynamics' | 'hubspot' | 'pipedrive' | 'salesforce' | 'sellsy' | 'zoho', required — CRM provider
    - `status` 'Open' | 'Closed won' | 'Closed lost' | 'Closed' | 'Deleted' | 'null', nullable, required — Deal status
    - `stage` string, nullable, required — Deal stage
    - `closeDate` string, nullable, required — Expected close date
    - `amount` number, nullable, required — Deal amount in the deal currency
    - `currency` string, nullable, required — Deal currency code
    - `probability` number, nullable, required — Probability of closing (0-100)
    - `lossReason` string, nullable, required — Reason for loss, if applicable
    - `source` string, nullable, required — Deal source
    - `accountId` number, nullable, required — Associated account ID
    - `ownerId` number, nullable, required — Owner user ID
    - `createdOn` string, nullable, required — Creation timestamp
    - `modifiedOn` string, nullable, required — Last modification timestamp
  - `pagination` object, required
    - `page` number, required — Current page number
    - `size` number, required — Items per page
    - `total` number, required — Total number of items

---

[API](https://skmtc.dev/modjo/apis/modjo-public-api.md) · [All operations](https://skmtc.dev/modjo/apis/modjo-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/modjo/modjo-public-api/revisions/dcae8b3284e8/schema)
