1. API
  2. Get Deal
GET
/crm/deal
vessel-api-token*

Parameters

accessTokenRequired
string
The token for the customer's CRM account. This was generated when they connected their account.
idRequired
string
allFields
boolean
Returns all fields including non-unifiable and custom fields under the "additional" property in the response

Response

deal
object
(Alias: Opportunity) An object representing either the opportunity to sell a product to an Account, or in the case of an `isWon` deal, a product sold to an Account. *CRM Caveats*: - Pipedrive: Users must have "Deal probability" turned on for the given pipeline for probability to be configurable and returned.
modifiedTimeRequired
string
The date the deal was last modified
createdTimeRequired
string
The date that the deal was created
closeDateRequired
string
When this deal is projected to be closed
nativeIdRequired
string
Id in the downstream CRM
idRequired
string
name
string
Optional name for this deal
stage
string
The stage of the pipeline the deal is in. See /deal/details for possible values
amount
number
Total deal money value
probability
string
Decimal probability of closing this deal.
expectedRevenue
number
probability * amount. This is a computed property
isWon
boolean
If this deal has been won. This is a computed property based on stage
isClosed
boolean
If this deal is closed (either closed-won or closed-lost). This is a computed property based on stage
additional
object
Returned when `allFields` is set in the query params. Includes all data, untransformed, we recieved from the downstream CRM