Skip to main content

​
List deals

​
page
integer
default:"1"
Page number
​
per_page
integer
default:"25"
Items per page (max 250)
​
sort
string
Sort field
​
order
string
default:"desc"
Sort order: asc or desc
​
q
string
Full-text search query
​
stage
string
Filter by stage: lead, prospect, negotiation, won, lost
​
company_id
string
Filter by company ID
​
contact_id
string
Filter by linked contact ID
​
min_value
number
Minimum deal value
​
max_value
number
Maximum deal value
​
tag
string
Filter by tag name
GET /api/v1/deals

​
Get a deal

GET /api/v1/deals/:id

​
Create a deal

POST /api/v1/deals
​
name
string
required
Deal name
​
stage
string
default:"lead"
Stage: lead, prospect, negotiation, won, lost
​
value
integer
Deal value in cents
​
currency
string
default:"USD"
3-letter currency code
​
expected_close
string
Expected close date (YYYY-MM-DD)
​
company_id
string
Company ID (UUID)
​
notes
string
Free-text notes
​
tags
string[]
Array of tag names
​
custom_fields
object
Custom field values as key-value pairs
Example
curl -X POST https://api.mosscrm.com/api/v1/deals \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp - Enterprise",
    "stage": "lead",
    "value": 5000000,
    "currency": "USD",
    "company_id": "cmp_abc123"
  }'

​
Update a deal

PATCH /api/v1/deals/:id
Accepts the same body fields as create (all optional), plus lost_reason.

​
Delete a deal

DELETE /api/v1/deals/:id

​
Move deal stage

Move a deal to a new pipeline stage. 
PATCH /api/v1/deals/:id/stage
​
stage
string
required
Target stage
​
lost_reason
string
Reason for loss (when moving to lost)

​
Bulk move stage

Move multiple deals to a new stage at once. 
PATCH /api/v1/deals/bulk-stage
​
deal_ids
string[]
required
Array of deal IDs (max 100)
​
stage
string
required
Target stage
​
lost_reason
string
Reason for loss

​
Deal Contacts

Manage contacts linked to a deal.

​
List deal contacts

GET /api/v1/deals/:id/contacts

POST /api/v1/deals/:id/contacts
​
contact_id
string
required
Contact ID (UUID)
​
role
string
Contact’s role in the deal (max 50 chars)
DELETE /api/v1/deals/:dealId/contacts/:contactId