Deals

List deals

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

get/deals

Query parameters

pageinteger

Page number (1-based)

Example:1

Page number (1-based)

sizeinteger

Number of items per page

Example:25

Number of items per page

namestring

Filter by deal name

account_idinteger

Filter by account ID

status'Open' | 'Closed won' | 'Closed lost' | 'Closed' | 'Deleted'

Filter by deal status (e.g. Open, Closed won, Closed lost)

Response

Paginated list of deals

Example response

{
  "data": [
    {
      "id": 1,
      "name": "Acme Corp - Enterprise Plan",
      "crmId": "006ABC123",
      "crmIdentifier": "006ABC123",
      "crmLink": "https://example.my.salesforce.com/006ABC123",
      "crm": "salesforce",
      "status": "Open",
      "stage": "Negotiation",
      "closeDate": "2024-09-30",
      "amount": 50000,
      "currency": "EUR",
      "probability": 75,
      "source": "Inbound",
      "accountId": 42,
      "ownerId": 7
    }
  ],
  "pagination": {
    "page": 1,
    "size": 25,
    "total": 100
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.