Pipedrive List

Pipedrive List

Certified

List and filter deals in Pipedrive CRM

Searches deals in Pipedrive using field filters such as pipeline, stage, status, or owner.

yaml
type: io.kestra.plugin.pipedrive.deals.List

List open deals in a pipeline

yaml
id: pipedrive_list_deals
namespace: company.team

tasks:
  - id: list_deals
    type: io.kestra.plugin.pipedrive.deals.List
    apiToken: "{{ secret('PIPEDRIVE_API_TOKEN') }}"
    pipelineId: 1
    status: "open"
    limit: 100
Properties

Pipedrive API token

Your Pipedrive API token for authentication.

Defaulthttps://api.pipedrive.com/api/v2

Pipedrive API URL

Base URL for the Pipedrive API. Override for testing purposes.

Cursor

Pagination cursor from a previous run's nextCursor output, used to fetch the next page of results

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch strategy

How to return the fetched deals. Valid values: 'FETCH' (as a list of objects) or 'STORE' (to internal storage). Defaults to 'FETCH'.

Filter ID

ID of a saved Pipedrive filter to apply

Limit

Maximum number of deals to return in a single page. If left unset, the Pipedrive API defaults to 100, up to a maximum of 500.

Organization ID

Only return deals associated with this organization

Owner ID

Only return deals owned by this user

Person ID

Only return deals associated with this person

Pipeline ID

Only return deals in this pipeline

Reference (ref) of the pluginDefaults to apply to this task.

Stage ID

Only return deals in this pipeline stage

Status

Only return deals with this status. Valid values: 'open', 'won', 'lost', 'deleted'

Count

Number of deals retrieved or stored

Deals

List of deals matching the filters, when fetchType is FETCH

Definitions
acvnumber
add_timestring
arrnumber
channelinteger
channel_idstring
close_timestring
currencystring
custom_fieldsobject
expected_close_datestring
idinteger
local_close_datestring
local_lost_datestring
local_won_datestring
lost_reasonstring
lost_timestring
mrrnumber
org_idinteger
originstring
origin_idstring
person_idinteger
pipeline_idinteger
probabilitynumber
stage_idinteger
statusstring
titlestring
update_timestring
user_idinteger
valuenumber
visible_tostring
won_timestring

Next cursor

Pagination cursor to pass as cursor on a subsequent run to fetch the next page, or null if there are no more results

Formaturi

URI

Stored deals location when fetchType is STORE