VUZDevelopers

List deals with filtering and pagination

GET
/crm/deals

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

pipelineId?string

Filter by pipeline UUID

stageId?string

Filter by stage UUID

clientId?string

Filter by client UUID

status?string

Filter by deal status

Value in

  • "open"
  • "won"
  • "lost"
  • "abandoned"
assignedToUserId?string

Filter by assigned user UUID

page?number

Page number (starting from 1)

Range1 <= value
Default1
limit?number

Number of items per page (max 100)

Range1 <= value <= 100
Default10

Response Body

application/json

curl -X GET "https://example.com/crm/deals"
{  "items": [    {      "id": "string",      "businessId": "string",      "pipelineId": "string",      "pipelineName": "string",      "stageId": "string",      "stageName": "string",      "title": "string",      "clientId": "string",      "clientName": "string",      "client": {        "id": "string",        "name": "string",        "phone": "string",        "email": "string"      },      "assignedToUserId": "string",      "assignedToUserName": "string",      "description": "string",      "status": "open",      "value": 0,      "probability": 0,      "currency": "string",      "expectedCloseDate": "string",      "source": "string",      "lostReason": "string",      "closedAt": "2019-08-24T14:15:22Z",      "lineItems": [        {          "id": "string",          "dealId": "string",          "productId": "string",          "description": "string",          "quantity": 0,          "unitPrice": 0,          "discountType": "PERCENT",          "discountValue": 0,          "vatRate": 0,          "itemVatMode": "exempt",          "lineSubTotal": 0,          "lineVatTotal": 0,          "lineGrandTotal": 0,          "sortOrder": 0,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "primaryQuoteStatus": "created",      "primaryQuoteViewCount": 0,      "primaryQuoteDocNumber": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "limit": 0}