Search Deals
pipedrive.search_deals
ActionCRM & salesconnection required
Calls the Pipedrive API with the connection's credentials.
Full-text search over deals with GET /api/v2/deals/search. Each match comes back as {result_score, item}.
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
8 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 |
|---|---|---|---|---|---|
term What to search for. Pipedrive needs at least two characters, or one with exact_match on. | string | Yes | — | ≥ 1 characters | — |
fields Comma-separated fields to search in, e.g. name,email. Defaults to every searchable field for the type. | string | No | — | — | — |
exact_match Only return records whose field matches the term exactly. | boolean | No | — | — | — |
person_id Only deals linked to this person. | string | No | — | — | — |
organization_id Only deals linked to this organization. | string | No | — | — | — |
status Lifecycle of the deal. | string | No | — | one of "open", "won", "lost", "deleted" | — |
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 matches on this page. | array | — |
items[].result_score Pipedrive's relevance score for this match. | number | — |
items[].item The matched record itself. | object | — |
count How many matches this page carried. | number | — |
next_cursor Feed back as the next call's `cursor`; null on the last page. | string | — |
more_items True when another page of matches exists. | boolean | — |
{
"count": 0,
"items": [
{
"item": {},
"result_score": 0
}
],
"more_items": false,
"next_cursor": ""
}See Search Deals 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.