FlowmageDocs

List leads

BetaReads dataVersion 2

Lists the leads sitting in the Pipedrive inbox.

Settings

SettingWhat it is
ConnectionRequiredThe Pipedrive connection the step signs in with.
Owner idThe List users node gives you the id.
Person idtext
Organization idtext
Saved filter idA filter you saved in Pipedrive.
Archived"" or "archived" or "not_archived" or "all"
Sort byA field name, with a leading minus for newest first.
Leads per call1 to 500. A lead list costs twenty tokens of the daily budget per call.
SkipHow many leads to skip. This is offset paging, not a cursor.
Fetch every pageWalks Pipedrive's offset paging, and refuses past 5,000 leads rather than answering a short list.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `pipedrive`)
ownerIdtextits `{{ }}` must give a string
personIdtextits `{{ }}` must give a string
organizationIdtextits `{{ }}` must give a string
filterIdtextits `{{ }}` must give a string
archivedStatus"" or "archived" or "not_archived" or "all"
sorttext
limitnumber, by default 100
startnumber, by default 0
returnAlltrue/false, by default false
cursortext

Output

FieldType
leadsarray
leadCountLeads in this answernumber
hasMoreMore leads are waiting behind this pageboolean
nextStartWhere the next page startsnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • leadCount0
  • leads[]
  • nextStart0

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": {
    "archivedStatus": "",
    "connection": "<connection id>",
    "cursor": "",
    "filterId": "",
    "limit": 100,
    "organizationId": "",
    "ownerId": "",
    "personId": "",
    "returnAll": false,
    "sort": "",
    "start": 0
  },
  "label": "List leads",
  "type": "pipedrive.listLeads",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe Pipedrive connection the step signs in with.
Owner idThe List users node gives you the id.
Person idtext
Organization idtext
Saved filter idA filter you saved in Pipedrive.
Archived"" or "archived" or "not_archived" or "all"
Sort byA field name, with a leading minus for newest first.
Leads per call1 to 500. A lead list costs twenty tokens of the daily budget per call.
SkipHow many leads to skip. This is offset paging, not a cursor.
Fetch every pageWalks Pipedrive's offset paging, and refuses past 5,000 leads rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `pipedrive`)
ownerIdtextits `{{ }}` must give a string
personIdtextits `{{ }}` must give a string
organizationIdtextits `{{ }}` must give a string
filterIdtextits `{{ }}` must give a string
archivedStatus"" or "archived" or "not_archived" or "all"
sorttext
limitnumber, by default 100
startnumber, by default 0
returnAlltrue/false, by default false