List deals
Deals from a Freshsales view, filtered by pipeline, stage or owner.
GET https://cotlet.dev/api/v1/freshsales/deals
read
Lists deals as the Deals module shows them for the view you pick, with the deal value, stage, pipeline, owner, account and expected close date. It reads a page at a time, so follow next_cursor to the end. Stage and pipeline names must match list_pipelines. A deal you cannot see in your Freshsales role is not returned.
Parameters
| Name | Type | Description |
|---|---|---|
| view string | string | Open Deals, My Deals, Won Deals or Hot Deals. Default Open Deals. |
| pipeline string | string | Pipeline name from list_pipelines. |
| stage string | string | Stage name from list_pipelines. |
| owner string | string | Name or email of the sales owner. |
| sort string | string | amount, expected_close, created_at, updated_at or last_contacted. |
| sort_type string | string | asc or desc. Default desc. |
| cursor string | string | next_cursor of the previous page. |
Request
curl https://cotlet.dev/api/v1/freshsales/deals \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("freshsales", "list_deals")const result = await cotlet.call('freshsales', 'list_deals');cotlet call freshsales list_dealsExample response
{
"deals": [
{
"deal_id": 7000412,
"name": "Website redesign",
"amount": 4800,
"stage": "Negotiation",
"pipeline": "Sales pipeline",
"owner": "Dana Reyes",
"account": "Northwind Studio",
"expected_close": "2026-10-28"
},
{
"deal_id": 7000388,
"name": "Annual support plan",
"amount": 12500,
"stage": "Follow-up",
"pipeline": "Sales pipeline",
"owner": "Dana Reyes",
"account": "Harbor Dental",
"expected_close": "2026-09-30"
}
],
"next_cursor": null
}