List Deal Fields
pipedrive.list_deal_fields
ActionCRM & salesconnection required
Calls the Pipedrive API with the connection's credentials.
List the field definitions for deals with GET /api/v2/dealFields. Read `key` off the field you want: that 40-character hash is how a custom field is written and read everywhere else in the API.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Pipedrive
- Secret shape
- the Pipedrive API token, or {"api_token": "…"}
- Config it needs
- company_domain
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 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_fields Comma-separated extra namespaces to include, e.g. ui_visibility. | string | No | — | — | — |
limit How many records to return in this page. Pipedrive caps a page at 500. | number | No | 100 | 1–500 | — |
cursor Paging marker from the previous call's `next_cursor` output. Leave empty for the first page. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 100
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Pipedrive returned them. | array | — |
count How many records this page carried. | number | — |
next_cursor Feed back as the next call's `cursor`. Null on the last page, and always null on a v1 collection, which pages with `next_start` instead. | string | — |
next_start Feed back as the next call's `start`. Null on the last page, and always null on a v2 collection, which pages with `next_cursor` instead. | number | — |
more_items True when Pipedrive says another page exists. | boolean | — |
{
"count": 0,
"items": [],
"more_items": false,
"next_cursor": "",
"next_start": 0
}Notes
- Each entry carries `key` (the hash used in custom_fields), `name` (what the UI shows), `field_type` and, for a set field, its `options`.
- Pipedrive caps a page at 500 records and defaults to 100.
See List Deal Fields run in a workflow.
In a technical demo we add the Pipedrive connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.