get
https://{youraccountname}.api-us1.com/api/3/deals/
One deal by its id: its title, value and currency, the pipeline (group) and stage it is in, its owner, its primary contact and account, and its status (0 open, 1 won, 2 lost). A user who is not allowed to see all deals can read only the deals they own and gets 403 for any other. A deal in a pipeline the user cannot see comes back with isDisabled true and only its id, title and status. Returns 404 if the deal does not exist, or if it has neither a primary contact nor an account. To list the deals on which one contact is the primary contact, use GET /contacts/{id}/deals; to find deals by status, stage, pipeline or owner, use GET /deals.
To retrieve a deal, the following permissions are required.
- Deal permission: the user should have permission to manage deals.
- Pipeline-specific permission: the user should have permission to manage the pipeline that the deal belongs to. If the user does not have the permission to manage the pipeline, limited deal data are returned with only
id,title, andisDisabledset totrue.
{
"deal": {
"owner": "1",
"contact": "39",
"organization": "20",
"group": "1",
"stage": "2",
"title": "Able Hyena",
"description": "Article do skill hope.",
"percent": "0",
"cdate": "2019-09-06T11:29:48-05:00",
"mdate": "2019-09-06T11:29:48-05:00",
"nextdate": null,
"nexttaskid": null,
"value": "1872151",
"currency": "usd",
"winProbability": 44,
"winProbabilityMdate": "2019-10-05T12:27:22-05:00",
"status": "0",
"activitycount": "1",
"nextdealid": "46",
"edate": "2019-11-22 14:15:37",
"links": {
"dealActivities": "/api/3/deals/46/dealActivities",
"contact":/api/3/deals/46/contact",
"contactDeals": "/api/3/deals/46/contactDeals",
"group": "/api/3/deals/46/group",
"nextTask": "/api/3/deals/46/nextTask",
"notes": "/api/3/deals/46/notes",
"account": "/api/3/deals/46/account",
"customerAccount": "/api/3/deals/46/customerAccount",
"organization": "/api/3/deals/46/organization",
"owner": "/api/3/deals/46/owner",
"scoreValues": "/api/3/deals/46/scoreValues",
"stage": "/api/3/deals/46/stage",
"tasks": "api/3/deals/46/tasks",
"dealCustomFieldData": "/api/3/deals/46/dealCustomFieldData"
},
"id": "46",
"isDisabled": false,
"account": "20",
"customerAccount": "20"
}
}