List deals
Deals with amount, sales stage, pipeline, expected close date and owner.
GET https://cotlet.dev/api/v1/vtiger/deals
read
Lists one page of deals from Main Menu > Sales > Deals, as the List View shows them. Filter by pipeline, sales_stage, owner or a search on the deal or organization name. amount is the number in the Amount field. Pass next_cursor back as cursor for the next page. Closed Won and Closed Lost deals come back like any other stage.
Parameters
| Name | Type | Description |
|---|---|---|
| pipeline string | string | Only deals in this sales pipeline. |
| sales_stage string | string | Only deals in this sales stage, named as in your pipeline. |
| assigned_to string | string | Only deals owned by this user. |
| query string | string | Deal or organization name to search for. |
| limit integer | integer | Deals per page. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/vtiger/deals \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("vtiger", "list_deals")const result = await cotlet.call('vtiger', 'list_deals');cotlet call vtiger list_dealsExample response
{
"deals": [
{
"record_id": "2041",
"name": "Whitfield Dental, 5 seats",
"organization": "Whitfield Dental",
"amount": 4200,
"sales_stage": "Proposal",
"pipeline": "Standard",
"expected_close_date": "2026-11-15",
"assigned_to": "Sam Rivera"
},
{
"record_id": "2044",
"name": "Ortega Builds, annual plan",
"organization": "Ortega Builds",
"amount": 9800,
"sales_stage": "Qualification",
"pipeline": "Standard",
"expected_close_date": "2026-12-01",
"assigned_to": "Sam Rivera"
}
],
"next_cursor": null
}