Get deal

One deal with its fields, related contact and journey tasks.

GET https://cotlet.dev/api/v1/vtiger/records/{record_id}/deal

read

Opens one deal as its Summary View shows it: the fields, the related contact and organization, and the journey tasks listed in its Tasks tab. Use it before update_deal_stage to read the current stage and probability. A record your role cannot see returns an error instead of empty fields.

Parameters

Parameters: get_deal
NameTypeDescription
record_id string required string Deal record id from list_deals.

Request

cURL
curl https://cotlet.dev/api/v1/vtiger/records/record_8c41d2/deal \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("vtiger", "get_deal", {"record_id":"record_8c41d2"})
Node.js
const result = await cotlet.call('vtiger', 'get_deal', {"record_id":"record_8c41d2"});
CLI
cotlet call vtiger get_deal --data '{"record_id":"record_8c41d2"}'

Example response

JSON

{
  "record_id": "2041",
  "name": "Whitfield Dental, 5 seats",
  "amount": 4200,
  "sales_stage": "Proposal",
  "pipeline": "Standard",
  "probability": 60,
  "expected_close_date": "2026-11-15",
  "assigned_to": "Sam Rivera",
  "contact": {
    "record_id": "1523",
    "name": "Dana Whitfield"
  },
  "journey_tasks": [
    {
      "title": "Send pricing sheet",
      "status": "Completed"
    },
    {
      "title": "Book demo call",
      "status": "Not Started"
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.