Get details of a deal
GET {{baseUrl}}/deals/:id?include_fields=<string>&custom_fields=<string>
Returns the details of a specific deal.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include_fields | string | Optional comma separated string array of additional fields to include | |
custom_fields | string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":{"id":1,"title":"Deal Title","creator_user_id":1,"owner_id":1,"value":200,"person_id":1,"org_id":1,"stage_id":1,"pipeline_id":1,"currency":"USD","add_time":"2021-01-01T00:00:00Z","update_time":"2021-01-01T00:00:00Z","stage_change_time":"2021-01-01T00:00:00Z","status":"open","is_deleted":false,"probability":90,"lost_reason":"Lost Reason","visible_to":7,"close_time":"2021-01-01T00:00:00Z","won_time":"2021-01-01T00:00:00Z","lost_time":"2021-01-01T00:00:00Z","local_won_date":"2021-01-01","local_lost_date":"2021-01-01","local_close_date":"2021-01-01","expected_close_date":"2021-01-01","label_ids":[1,2,3],"origin":"ManuallyCreated","origin_id":null,"channel":52,"channel_id":"Jun23 Billboards","acv":120,"arr":120,"mrr":10,"custom_fields":{}}}