List Deal Fields
freshworks_crm.list_deal_fields
ActionCRM & salesconnection required
Calls the Freshworks CRM API with the connection's credentials.
List every field defined on the deal form, including custom fields and their choices, so a workflow can build a valid payload.
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
1 field, none 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 |
|---|---|---|---|---|---|
include Set to 'field_group' to return each field alongside the group it belongs to. | string | No | — | one of "field_group" | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The deal field definitions 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 Deal Fields 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.