List Deals
freshworks_crm.list_deals
ActionCRM & salesconnection required
Calls the Freshworks CRM API with the connection's credentials.
Fetch one page of deals from a saved view. Freshworks lists records only through a view, so take the view id from the List Views node first.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Freshworks CRM
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- bundle_alias, domain, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
view_id The id of the deal view to read, as returned by the List Views node. | string | Yes | — | — | — |
page Which page of the view to fetch. Pages hold 25 records and start at 1. | number | No | 1 | ≥ 1 | — |
sort The field to sort by. Freshworks documents lead_score, created_at, updated_at, open_deals_amount and last_contacted for contacts. | string | No | — | — | — |
sort_type The sort direction to apply to the sort field. | string | No | asc | one of "asc", "desc" | — |
include Comma-separated related resources to embed in the response, such as 'owner,targetable'. Freshworks documents which values each resource accepts. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"page": 1,
"sort_type": "asc"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The deals on this page, as Freshworks returned them. | array | — |
count How many records this page actually contains. | number | — |
total The total the response's 'meta' block reports, falling back to the size of this page when Freshworks sends no meta block. | number | — |
{
"count": 0,
"items": [],
"total": 0
}See List Deals run in a workflow.
In a technical demo we add the Freshworks CRM connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.