Skip to main content

​
List deals

​
integer
default:"1"
Page number
​
integer
default:"25"
Items per page (max 250)
​
string
Sort field
​
string
default:"desc"
Sort order: asc or desc
​
string
Full-text search query
​
string
Filter by stage: lead, prospect, negotiation, won, lost
​
string
Filter by company ID
​
string
Filter by linked contact ID
​
number
Minimum deal value
​
number
Maximum deal value
​
string
Filter by tag name

​
Get a deal

​
Create a deal

​
string
required
Deal name
​
string
default:"lead"
Stage: lead, prospect, negotiation, won, lost
​
integer
Deal value in cents
​
string
default:"USD"
3-letter currency code
​
string
Expected close date (YYYY-MM-DD)
​
string
Company ID (UUID)
​
string
Free-text notes
​
string[]
Array of tag names
​
object
Custom field values as key-value pairs
Example

​
Update a deal

Accepts the same body fields as create (all optional), plus lost_reason.

​
Delete a deal

​
Move deal stage

Move a deal to a new pipeline stage.
​
string
required
Target stage
​
string
Reason for loss (when moving to lost)

​
Bulk move stage

Move multiple deals to a new stage at once.
​
string[]
required
Array of deal IDs (max 100)
​
string
required
Target stage
​
string
Reason for loss

​
Deal Contacts

Manage contacts linked to a deal.

​
List deal contacts

​
string
required
Contact ID (UUID)
​
string
Contact’s role in the deal (max 50 chars)