Retrieve a deal
GET/crm/{connection_id}/deal/{id}
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Deal
Returns
A deal represents an opportunity with companies and/or contacts
idstring
Unique identifier for this deal object
created_atdate
The date that this deal object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this deal object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The name of this deal
amountnumber
The potential amount that deal could be worth
currencystring
The currency for the deal amount (3 letter ISO code; eg. USD)
closed_atdate
The date that this deal closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closing_atdate
expected closing date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
stagestring
@deprecated Use stages array instead
stage_idstring
@deprecated Use stages array instead
pipelinestring
@deprecated Use pipelines array instead
pipeline_idstring
@deprecated Use pipelines array instead
sourcestring
The source for this deal
probabilitynumber
tagsstring array
lost_reasonstring
won_reasonstring
user_idstring
(reference to HrisEmployee)
contact_idsstring array
(reference to CrmContact)
company_idsstring array
(reference to CrmCompany)
const options = {
method: 'GET',
url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know