PipedriveList records
BetaReads data
Lists Pipedrive deals, people, organizations, activities or products.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Pipedrive connection the step signs in with. |
| Records | "deals" or "persons" or "organizations" or "activities" or "products" |
| Saved filter id | A filter you saved in Pipedrive. When it is set, every other filter on this node is ignored — that is Pipedrive's own rule. |
| Owner id | The List users node gives you the id. |
| Person id | text |
| Organization id | text |
| Pipeline id | Picked from the list Pipedrive offers. |
| Stage id | Picked from the list Pipedrive offers. |
| Status | "" or "open" or "won" or "lost" or "deleted" |
| Done | "" or "true" or "false" |
| Changed since | text |
| Changed before | text |
| Sort by | "id" or "update_time" or "add_time" |
| Direction | "asc" or "desc" |
| Extra fields | Comma-separated. Fields Pipedrive leaves out of a list unless you ask. |
| Custom fields | Comma-separated field codes, at most 15. The List field definitions node turns a label into its code. |
| Spell out dropdown values | Returns { id, label } for single and multi-select custom fields. |
| Include labels | true/false |
| Records per call | 1 to 500. A list read costs about ten tokens of the daily budget however many records come back. |
| Start after | A cursor from an earlier run of this node. Leave empty to start over. |
| Fetch every page | Follows Pipedrive's cursor, and refuses past 5,000 records rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `pipedrive`) |
recordType | "deals" or "persons" or "organizations" or "activities" or "products", by default "deals" |
filterId | textits `{{ }}` must give a string |
ownerId | texta value from the vendor's own list |
personId | textits `{{ }}` must give a string; used when `recordType` is one of "deals", "activities" |
orgId | textits `{{ }}` must give a string; used when `recordType` is one of "deals", "activities" |
pipelineId | texta value from the vendor's own list; used when `recordType` is "deals" |
stageId | texta value from the vendor's own list; used when `recordType` is "deals" |
status | "" or "open" or "won" or "lost" or "deleted"used when `recordType` is "deals" |
done | "" or "true" or "false"used when `recordType` is "activities" |
updatedSince | textits `{{ }}` must give a string |
updatedUntil | textits `{{ }}` must give a string |
sortBy | "id" or "update_time" or "add_time", by default "id" |
sortDirection | "asc" or "desc", by default "asc" |
includeFields | text |
customFields | text |
includeOptionLabels | true/false, by default false |
includeLabels | true/false, by default false |
limit | number, by default 100 |
cursor | text |
returnAll | true/false, by default false |
Output
| Field | Type |
|---|---|
records | array |
recordCountRecords in this answer | number |
hasMoreMore records are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- nextCursor""
- recordCount0
- records[]
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": "",
"customFields": "",
"done": "",
"filterId": "",
"includeFields": "",
"includeLabels": false,
"includeOptionLabels": false,
"limit": 100,
"orgId": "",
"ownerId": "",
"personId": "",
"pipelineId": "",
"recordType": "deals",
"returnAll": false,
"sortBy": "id",
"sortDirection": "asc",
"stageId": "",
"status": "",
"updatedSince": "",
"updatedUntil": ""
},
"label": "List records",
"type": "pipedrive.listRecords",
"version": 1
}