Pipedrive List
CertifiedList and filter persons in Pipedrive CRM
Pipedrive List
List and filter persons in Pipedrive CRM
Searches persons in Pipedrive using field filters such as organization or owner.
type: io.kestra.plugin.pipedrive.persons.ListExamples
List persons owned by a user
id: pipedrive_list_persons
namespace: company.team
tasks:
- id: list_persons
type: io.kestra.plugin.pipedrive.persons.List
apiToken: "{{ secret('PIPEDRIVE_API_TOKEN') }}"
ownerId: 7
limit: 100
Properties
apiToken *Requiredstring
Pipedrive API token
Your Pipedrive API token for authentication.
apiUrl string
https://api.pipedrive.com/api/v2Pipedrive API URL
Base URL for the Pipedrive API. Override for testing purposes.
cursor string
Cursor
Pagination cursor from a previous run's nextCursor output, used to fetch the next page of results
fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch strategy
How to return the fetched persons. Valid values: 'FETCH' (as a list of objects) or 'STORE' (to internal storage). Defaults to 'FETCH'.
filterId integerstring
Filter ID
ID of a saved Pipedrive filter to apply
limit integerstring
Limit
Maximum number of persons to return in a single page. If left unset, the Pipedrive API defaults to 100, up to a maximum of 500.
orgId integerstring
Organization ID
Only return persons associated with this organization
ownerId integerstring
Owner ID
Only return persons owned by this user
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
count integer
Count
Number of persons retrieved or stored
nextCursor string
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
persons array
Persons
List of persons matching the filters, when fetchType is FETCH
io.kestra.plugin.pipedrive.models.Person
io.kestra.plugin.pipedrive.models.Person-EmailInfo
io.kestra.plugin.pipedrive.models.Person-PhoneInfo
uri string
uriURI
Stored persons location when fetchType is STORE
