Deals API

The Deals API provides access to the deal pipeline — listing deals, filtering by stage/type/rep, and retrieving pipeline summary metrics.

Endpoints

List Deals

GET /api/deals

Returns all deals with optional filtering.

Query Parameters:

Parameter	Type	Description	Example
`stage`	string	Filter by deal stage	`negotiation`
`type`	string	Filter by deal type	`new-business`
`rep`	string	Filter by assigned rep	`sarah-ae-west`

Example:

GET /api/deals?stage=negotiation&type=new-business

Response:

{
  "deals": [
    {
      "id": "deal-001",
      "accountName": "Acme Corp",
      "value": 2100000,
      "stage": "negotiation",
      "type": "expansion",
      "rep": "sarah-ae-west",
      "champion": "Sarah Kim",
      "closeDate": "2026-03-31",
      "probability": 75
    }
  ],
  "total": 1
}

Get Deal

GET /api/deals/:id

Returns detailed information about a specific deal.

Response:

{
  "id": "deal-001",
  "accountName": "Acme Corp",
  "value": 2100000,
  "stage": "negotiation",
  "type": "expansion",
  "rep": "sarah-ae-west",
  "champion": "Sarah Kim",
  "championStatus": "active",
  "closeDate": "2026-03-31",
  "probability": 75,
  "nextStep": "QBR scheduled for March 10",
  "history": [
    { "date": "2026-01-15", "action": "Moved to qualification" },
    { "date": "2026-02-01", "action": "Moved to proposal" },
    { "date": "2026-02-20", "action": "Moved to negotiation" }
  ]
}

Pipeline Summary

GET /api/deals/summary/pipeline

Returns aggregate pipeline metrics.

Response:

{
  "total": 32500000,
  "dealCount": 12,
  "byStage": {
    "prospecting": { "value": 3200000, "count": 3 },
    "qualification": { "value": 5800000, "count": 2 },
    "proposal": { "value": 8500000, "count": 3 },
    "negotiation": { "value": 11200000, "count": 2 },
    "closed-won": { "value": 3800000, "count": 2 }
  },
  "byType": {
    "new-business": { "value": 12000000, "count": 4 },
    "expansion": { "value": 15500000, "count": 5 },
    "renewal": { "value": 5000000, "count": 3 }
  }
}

Deal Stages

Stage	Description
`prospecting`	Initial outreach, no engagement yet
`qualification`	Engaged, qualifying fit and budget
`proposal`	Proposal or POC delivered
`negotiation`	Terms being negotiated
`closed-won`	Deal signed
`closed-lost`	Deal lost

Deal Types

Type	Description
`new-business`	Net-new customer acquisition
`expansion`	Existing customer upsell/cross-sell
`renewal`	Contract renewal

Deals API

Deals API

Endpoints

List Deals

Get Deal

Pipeline Summary

Deal Stages

Deal Types

On this page