PipedriveSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Pipedrive connection the step signs in with. |
| Search in | "all" or "deals" or "persons" or "organizations" or "leads" or "products" |
| Search termRequired | At least two characters, or one when Exact match is on. Search costs twenty to forty tokens of the daily budget and is capped at ten calls every two seconds on every plan. |
| Fields to search | Comma-separated. People take custom_fields, email, name, notes, phone; deals take custom_fields, notes, title; organizations take address, custom_fields, name, notes. Leave empty for Pipedrive's own default. |
| Exact match | Only whole-value matches, and then one character is enough. |
| Only for person id | text |
| Only for organization id | text |
| Only deals that are | "" or "open" or "won" or "lost" |
| Include related records | Adds the deals and organizations a matching person is attached to. |
| Extra fields | Comma-separated. Fields Pipedrive leaves out of a result unless you ask. |
| Results per call | 1 to 500. |
| Start after | A cursor from an earlier run of this node. |
| Fetch every page | Follows Pipedrive's cursor, and refuses past 5,000 results rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `pipedrive`) |
scope | "all" or "deals" or "persons" or "organizations" or "leads" or "products", by default "persons" |
term | textits `{{ }}` must give a string |
fields | text |
exactMatch | true/false, by default false |
personId | textits `{{ }}` must give a string; used when `scope` is "deals" |
organizationId | textits `{{ }}` must give a string; used when `scope` is one of "deals", "persons" |
status | "" or "open" or "won" or "lost"used when `scope` is "deals" |
searchForRelatedItems | true/false, by default falseused when `scope` is "all" |
includeFields | text |
limit | number, by default 100 |
cursor | text |
returnAll | true/false, by default false |
Output
| Field | Type |
|---|---|
itemsMatches | array |
itemCountMatches in this answer | number |
hasMoreMore matches are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- itemCount0
- items[]
- nextCursor""
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"cursor": "",
"exactMatch": false,
"fields": "",
"includeFields": "",
"limit": 100,
"organizationId": "",
"personId": "",
"returnAll": false,
"scope": "persons",
"searchForRelatedItems": false,
"status": "",
"term": "<search term>"
},
"label": "Search",
"type": "pipedrive.search",
"version": 1
}