Overview
A configuration is provided for establishing connections with the Pipedrive service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Pipedrive REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Pipedrive instance.
In this guide, we will show how to read data from the Pipedrive service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Pipedrive service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://api.pipedrive.com/v1
.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://pipedrive.readme.io/docs/marketplace-oauth-authorization.
-
Authorization:
- Private Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token: Required. Specify API token.
The following request parameters will be automatically processed during the authentication process:
-
api_token:
{{=connection.user.Token}}
Documentation: https://pipedrive.readme.io/docs/how-to-find-the-api-token.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activities
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities/get_activities.
- [Read deal] action
-
Endpoint URL address:
/deals/{{=parameters.deal_id}}/activities
.The action has the following user-defined parameters:
- deal_id: Required. Specify deal identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_activities.
- [Read organization] action
-
Endpoint URL address:
/organizations/{{=parameters.org_id}}/activities
.The action has the following user-defined parameters:
- org_id: Required. Specify organization identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_activities.
- [Read person] action
-
Endpoint URL address:
/persons/{{=parameters.person_id}}/activities
.The action has the following user-defined parameters:
- person_id: Required. Specify person identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_activities.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
activity
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/activities
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities/post_activities.
- [Update] action
-
Endpoint URL address:
/activities/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities/put_activities_id.
- [Delete] action
-
Endpoint URL address:
/activities
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities/delete_activities.
-
ids:
- id
A key field. Data type: DT_I4
- active_flag
Data type: DT_BOOL
- assigned_to_user_id
Data type: DT_I4
- company_id
Data type: DT_I4
- deal_dropbox_bcc
Template: ShortText.
- person_dropbox_bcc
Template: ShortText.
- deal_title
Template: ShortText.
- gcal_event_id
Template: ShortText.
- google_calendar_etag
Template: ShortText.
- google_calendar_id
Template: ShortText.
- local_due_time_for_sorting
Template: DateTime.
- org_name
Template: ShortText.
- owner_name
Template: ShortText.
- participants
Field components:
- An array.
- Contains the following components: person_id, primary_flag.
- person_email
Template: ShortText.
- person_name
Template: ShortText.
- person_phone
Template: ShortText.
- reference_id
Template: ShortText.
- reference_type
Template: ShortText.
- conference_meeting_client
Template: ShortText.
- conference_meeting_url
Template: ShortText.
- notification_language_id
Data type: DT_I4
- calendar_sync_include_context
Template: ShortText.
- lead_id
Data type: DT_I4
- update_user_id
Template: User.
- source_timezone
Template: ShortText.
- rec_rule
Template: ShortText.
- rec_rule_extension
Template: ShortText.
- rec_master_activity_id
Template: ShortText.
- conference_meeting_id
Data type: DT_I4
- series
Template: ShortText.
- note_clean
Template: ShortText.
- attendees
Field components:
- An array.
- Contains the following components: email_address, name, status, is_organizer, person_id, user_id.
- [External]
-
The external fields URL address:
/activityFields
. The external fields list is extracted from:{{=response.data}}
.- {{=external.key}}
Template: {{=Pipedrive.getFieldTemplate(external.field_type)}}. Data type: {{=Pipedrive.getDataType(external.field_type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activityTypes
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/get_activityTypes.
- [Create] action
-
Endpoint URL address:
/activityTypes
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/post_activityTypes.
- [Update] action
-
Endpoint URL address:
/activityTypes/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/put_activityTypes_id.
- [Delete] action
-
Endpoint URL address:
/activityTypes
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/delete_activityTypes.
-
ids:
- id
A key field. Data type: DT_I4
- order_nr
Data type: DT_I4
- name
Template: ShortText.
- key_string
Template: ShortText.
- icon_key
Template: ShortText.
- active_flag
Data type: DT_BOOL
- color
Template: ShortText.
- is_custom_flag
Data type: DT_BOOL
- add_time
Template: DateTime. A read-only field.
- update_time
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/callLogs
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/CallLogs/get_callLogs.
- [Create] action
-
Endpoint URL address:
/callLogs
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/CallLogs/post_callLogs.
- [Delete] action
-
Endpoint URL address:
/callLogs/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/CallLogs/delete_callLogs_id.
- id
A key field. Data type: DT_I4
- user_id
Data type: DT_I4
- activity_id
Data type: DT_I4
- subject
Template: ShortText.
- from_phone_number
Template: ShortText.
- to_phone_number
Template: ShortText.
- outcome
Template: ShortText.
- start_time
Template: DateTime.
- end_time
Template: DateTime.
- person_id
Data type: DT_I4
- org_id
Data type: DT_I4
- deal_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/currencies
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Currencies/get_currencies.
- id
Data type: DT_I4
- code
Template: ShortText.
- name
Template: ShortText.
- decimal_points
Data type: DT_I4
- symbol
Template: ShortText.
- active_flag
Data type: DT_BOOL
- is_custom_flag
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/deals
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals.
- [Read search] action
-
Endpoint URL address:
/deals/search
.The action has the following user-defined parameters:
- term: Required. Specify search term.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_search.
- [Read organization] action
-
Endpoint URL address:
/organizations/{{=parameters.org_id}}/deals
.The action has the following user-defined parameters:
- org_id: Required. Specify organization identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_deals.
- [Read person] action
-
Endpoint URL address:
/persons/{{=parameters.person_id}}/deals
.The action has the following user-defined parameters:
- person_id: Required. Specify person identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_deals.
- [Read pipeline] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipeline_id}}/deals
.The action has the following user-defined parameters:
- pipeline_id: Required. Specify pipeline identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines_id_deals.
- [Read product] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/deals
.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id_deals.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
deal
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/deals
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals/post_deals.
- [Update] action
-
Endpoint URL address:
/deals/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals/put_deals_id.
- [Delete] action
-
Endpoint URL address:
/deals
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals/delete_deals.
-
ids:
The resource includes the fields from the Deal template.
- activities
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Activity'].getData({ endpoint: 'deal', parameters: ['deal_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Activity
.
- files
A read-only field. The gathered value is processed with
{{=connection.resourceManager['File'].getData({ endpoint: 'deal', parameters: ['deal_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
File
.
- updates
A read-only field. The value is gathered from
/deals/{{=item.id}}/flow
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
- Contains the following components: object, timestamp, data.
- followers
A read-only field. The value is gathered from
/deals/{{=item.id}}/followers
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
-
Uses template:
Follower
.
- mail_messages
Template: LongText. A read-only field. A composite field. The value is gathered from
/deals/{{=item.id}}/mailMessages
address. The gathered value is processed with{{=response.data}}
expression.- participants
A read-only field. The value is gathered from
/deals/{{=item.id}}/participants
address. Field components:- An array.
- Contains the following components: id, person_id, add_time, active_flag, related_item_data, person, added_by_user_id, related_item_type, related_item_id.
- permitted_users
Template: LongText. A read-only field. A composite field. The value is gathered from
/deals/{{=item.id}}/permittedUsers
address.- persons
A read-only field. The value is gathered from
/deals/{{=item.id}}/persons
address. Field components:- An array.
-
Uses template:
Person
.
- products
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Product'].getData({ endpoint: 'deal', parameters: ['deal_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Product
.
- [External]
-
The external fields URL address:
/dealFields
. The external fields list is extracted from:{{=response.data}}
.- {{=external.key}}
Template: {{=Pipedrive.getFieldTemplate(external.field_type)}}. Data type: {{=Pipedrive.getDataType(external.field_type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dealFields
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/DealFields/get_dealFields.
- [Create] action
-
Endpoint URL address:
/dealFields
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/DealFields/post_dealFields.
- [Update] action
-
Endpoint URL address:
/dealFields/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/DealFields/put_dealFields_id.
- [Delete] action
-
Endpoint URL address:
/dealFields
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/DealFields/delete_dealFields.
-
ids:
The resource includes the fields from the CustomField template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Files/get_files.
- [Read organization] action
-
Endpoint URL address:
/organizations/{{=parameters.org_id}}/files
.The action has the following user-defined parameters:
- org_id: Required. Specify organization identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_files.
- [Read person] action
-
Endpoint URL address:
/persons/{{=parameters.person_id}}/files
.The action has the following user-defined parameters:
- person_id: Required. Specify person identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_files.
- [Read product] action
-
Endpoint URL address:
/products/{{=parameters.id}}/files
.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id_files.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
file
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/files
.The following request parameters will be automatically processed:
-
file:
{{=item.content}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Files/post_files.
-
file:
- [Update] action
-
Endpoint URL address:
/files/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Files/put_files_id.
- [Delete] action
-
Endpoint URL address:
/files/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Files/delete_files_id.
The resource includes the fields from the File template.
- content
Data type: DT_IMAGE The value is gathered from
/files/{{=item.id}}/download
address.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/filters
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Filters/get_filters.
- [Create] action
-
Endpoint URL address:
/filters
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Filters/post_filters.
- [Update] action
-
Endpoint URL address:
/filters/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Filters/put_filters_id.
- [Delete] action
-
Endpoint URL address:
/filters
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Filters/delete_filters.
-
ids:
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- active_flag
Data type: DT_BOOL
- type
Template: ShortText.
- temporary_flag
Template: ShortText.
- user_id
Data type: DT_I4
- add_time
Template: DateTime. A read-only field.
- update_time
Template: DateTime. A read-only field.
- visible_to
Template: ShortText.
- custom_view_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/goals/find
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Goals/get_goals_find.
- [Create] action
-
Endpoint URL address:
/goals
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Goals/post_goals.
- [Update] action
-
Endpoint URL address:
/goals/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Goals/put_goals_id.
- [Delete] action
-
Endpoint URL address:
/goals/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Goals/delete_goals_id.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- assignee
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type.
-
Uses template:
- type
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, params.
-
Uses template:
- expected_outcome
Field components:
-
Uses template:
ShortText
. - Contains the following components: target, tracking_metric, currency_id.
-
Uses template:
- duration
Field components:
-
Uses template:
DateTime
. - Contains the following components: start, end.
-
Uses template:
- interval
Template: ShortText.
- [Read] action
-
Endpoint URL address:
/itemSearch
.The action has the following user-defined parameters:
- term: Required. Specify search term.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch.
- result_score
Data type: DT_R8
- item
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, name, phones, emails, visible_to, owner, organization, custom_fields, notes.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/leads
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Leads/get_leads.
- [Create] action
-
Endpoint URL address:
/leads
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Leads/post_leads.
- [Update] action
-
Endpoint URL address:
/leads/{{=item.id}}
.
The action uses PATCH method.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Leads/patch_leads_id.
- [Delete] action
-
Endpoint URL address:
/leads/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Leads/delete_leads_id.
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- owner_id
Data type: DT_I4
- creator_id
Data type: DT_I4 A read-only field.
- label_ids
Template: LongText. A composite field.
- value
Template: ShortText.
- expected_close_date
Template: ShortText.
- note
Template: ShortText.
- person_id
Template: ShortText.
- organization_id
Template: ShortText.
- is_archived
Data type: DT_BOOL A read-only field.
- source_name
Template: ShortText. A read-only field.
- was_seen
Data type: DT_BOOL A read-only field.
- next_activity_id
Template: ShortText. A read-only field.
- add_time
Template: DateTime. A read-only field.
- update_time
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/mailbox/mailThreads
.The action has the following user-defined parameters:
- folder: Required. Specify type of folder.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/get_mailbox_mailThreads.
- [Update] action
-
Endpoint URL address:
/mailbox/mailThreads/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/put_mailbox_mailThreads_id.
- [Delete] action
-
Endpoint URL address:
/mailbox/mailThreads/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/delete_mailbox_mailThreads_id.
- id
Data type: DT_I4
- deal_id
Data type: DT_I4
- shared_flag
Data type: DT_I4
- read_flag
Data type: DT_I4
- archived_flag
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notes
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes/get_notes.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
note
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/notes
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes/post_notes.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes/put_notes_id.
- [Delete] action
-
Endpoint URL address:
/notes/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes/delete_notes_id.
- id
A key field. Data type: DT_I4
- content
Template: LongText.
- active_flag
Data type: DT_BOOL
- last_update_user_id
Template: ShortText.
- organization
Field components:
-
Uses template:
ShortText
. - Contains the following components: name.
-
Uses template:
- person
Field components:
-
Uses template:
ShortText
. - Contains the following components: name.
-
Uses template:
- deal
Field components:
-
Uses template:
ShortText
. - Contains the following components: title.
-
Uses template:
- user
Field components:
-
Uses template:
ShortText
. - Contains the following components: email, name, icon_url, is_you.
-
Uses template:
- [External]
-
The external fields URL address:
/noteFields
. The external fields list is extracted from:{{=response.data}}
.- {{=external.key}}
Template: {{=Pipedrive.getFieldTemplate(external.field_type)}}. Data type: {{=Pipedrive.getDataType(external.field_type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organizationFields
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/get_organizationFields.
- [Update] action
-
Endpoint URL address:
/organizationFields/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/put_organizationFields_id.
- [Delete] action
-
Endpoint URL address:
/organizationFields
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/delete_organizationFields.
-
ids:
The resource includes the fields from the CustomField template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organizations
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations.
- [Read search] action
-
Endpoint URL address:
/organizations/search
.The action has the following user-defined parameters:
- term: Required. Specify search term.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_search.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
organization
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/organizations
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/post_organizations.
- [Update] action
-
Endpoint URL address:
/organizations/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/put_organizations_id.
- [Delete] action
-
Endpoint URL address:
/organizations
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations.
-
ids:
- id
A key field. Data type: DT_I4
- company_id
Data type: DT_I4
- open_deals_count
Data type: DT_I4 A read-only field.
- related_open_deals_count
Data type: DT_I4 A read-only field.
- related_closed_deals_count
Data type: DT_I4 A read-only field.
- files_count
Data type: DT_I4 A read-only field.
- notes_count
Data type: DT_I4 A read-only field.
- followers_count
Data type: DT_I4 A read-only field.
- related_won_deals_count
Data type: DT_I4 A read-only field.
- related_lost_deals_count
Data type: DT_I4 A read-only field.
- active_flag
Data type: DT_BOOL
- category_id
Template: ShortText.
- country_code
Template: ShortText.
- first_char
Template: ShortText.
- next_activity_time
Template: ShortText.
- next_activity_id
Data type: DT_I4
- last_activity_id
Template: ShortText.
- owner_name
Template: ShortText.
- cc_email
Template: ShortText.
- activities
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Activity'].getData({ endpoint: 'organization', parameters: ['org_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Activity
.
- deals
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Deal'].getData({ endpoint: 'organization', parameters: ['org_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Deal
.
- files
A read-only field. The gathered value is processed with
{{=connection.resourceManager['File'].getData({ endpoint: 'organization', parameters: ['org_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
File
.
- updates
A read-only field. The value is gathered from
/organizations/{{=item.id}}/flow
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
- Contains the following components: object, timestamp, data.
- followers
A read-only field. The value is gathered from
/organizations/{{=item.id}}/followers
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
-
Uses template:
Follower
.
- mail_messages
Template: LongText. A read-only field. A composite field. The value is gathered from
/organizations/{{=item.id}}/mailMessages
address. The gathered value is processed with{{=response.data}}
expression.- persons
A read-only field. The value is gathered from
/organizations/{{=item.id}}/persons
address. Field components:- An array.
-
Uses template:
Person
.
- [External]
-
The external fields URL address:
/organizationFields
. The external fields list is extracted from:{{=response.data}}
.- {{=external.key}}
Template: {{=Pipedrive.getFieldTemplate(external.field_type)}}. Data type: {{=Pipedrive.getDataType(external.field_type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organizationRelationships
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/get_organizationRelationships.
- [Create] action
-
Endpoint URL address:
/organizationRelationships
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/post_organizationRelationships.
- [Update] action
-
Endpoint URL address:
/organizationRelationships/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/put_organizationRelationships_id.
- [Delete] action
-
Endpoint URL address:
/organizationRelationships/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/delete_organizationRelationships_id.
- id
A key field. Data type: DT_I4
- org_id
Data type: DT_I4
- type
Template: ShortText.
- rel_owner_org_id
Data type: DT_I4
- rel_linked_org_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/persons
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons.
- [Read search] action
-
Endpoint URL address:
/persons/search
.The action has the following user-defined parameters:
- term: Required. Specify search term.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_search.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
person
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/persons
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/post_persons.
- [Update] action
-
Endpoint URL address:
/persons/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/put_persons_id.
- [Delete] action
-
Endpoint URL address:
/persons
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons/delete_persons.
-
ids:
The resource includes the fields from the Person template.
- activities
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Activity'].getData({ endpoint: 'person', parameters: ['person_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Activity
.
- deals
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Deal'].getData({ endpoint: 'person', parameters: ['person_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Deal
.
- files
A read-only field. The gathered value is processed with
{{=connection.resourceManager['File'].getData({ endpoint: 'person', parameters: ['person_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
File
.
- updates
A read-only field. The value is gathered from
/persons/{{=item.id}}/flow
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
- Contains the following components: object, timestamp, data.
- followers
A read-only field. The value is gathered from
/persons/{{=item.id}}/followers
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
-
Uses template:
Follower
.
- mail_messages
Template: LongText. A read-only field. A composite field. The value is gathered from
/persons/{{=item.id}}/mailMessages
address. The gathered value is processed with{{=response.data}}
expression.- products
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Product'].getData({ endpoint: 'person', parameters: ['person_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Product
.
- [External]
-
The external fields URL address:
/personFields
. The external fields list is extracted from:{{=response.data}}
.- {{=external.key}}
Template: {{=Pipedrive.getFieldTemplate(external.field_type)}}. Data type: {{=Pipedrive.getDataType(external.field_type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pipelines
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
pipeline
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/pipelines
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/post_pipelines.
- [Update] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/put_pipelines_id.
- [Delete] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/delete_pipelines_id.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url_title
Template: ShortText.
- order_nr
Data type: DT_I4
- active
Data type: DT_BOOL
- deal_probability
Data type: DT_BOOL
- add_time
Template: DateTime. A read-only field.
- update_time
Template: DateTime. A read-only field.
- selected
Data type: DT_BOOL
- deals
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Deal'].getData({ endpoint: 'pipeline', parameters: ['pipeline_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Deal
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products.
- [Read search] action
-
Endpoint URL address:
/products/search
.The action has the following user-defined parameters:
- term: Required. Specify search term.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_search.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
product
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/products
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/post_products.
- [Update] action
-
Endpoint URL address:
/products/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/put_products_id.
- [Delete] action
-
Endpoint URL address:
/products/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products/delete_products_id.
The resource includes the fields from the Product template.
- deals
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Deal'].getData({ endpoint: 'product', parameters: ['product_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
Deal
.
- files
A read-only field. The gathered value is processed with
{{=connection.resourceManager['File'].getData({ endpoint: 'product', parameters: ['product_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
File
.
- followers
A read-only field. The value is gathered from
/products/{{=item.id}}/followers
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
-
Uses template:
Follower
.
- [External]
-
The external fields URL address:
/productFields
. The external fields list is extracted from:{{=response.data}}
.- {{=external.key}}
Template: {{=Pipedrive.getFieldTemplate(external.field_type)}}. Data type: {{=Pipedrive.getDataType(external.field_type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/productFields
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/get_productFields.
- [Create] action
-
Endpoint URL address:
/productFields
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/post_productFields.
- [Update] action
-
Endpoint URL address:
/productFields/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/put_productFields_id.
- [Delete] action
-
Endpoint URL address:
/productFields
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/delete_productFields.
-
ids:
The resource includes the fields from the CustomField template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/roles
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Roles/get_roles.
- [Create] action
-
Endpoint URL address:
/roles
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Roles/post_roles.
- [Update] action
-
Endpoint URL address:
/roles/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Roles/put_roles_id.
- [Delete] action
-
Endpoint URL address:
/roles/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Roles/delete_roles_id.
- id
A key field. Data type: DT_I4
- parent_role_id
Template: ShortText.
- name
Template: ShortText.
- active_flag
Data type: DT_BOOL A read-only field.
- assignment_count
Template: ShortText. A read-only field.
- sub_role_count
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/stages
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Stages/get_stages.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
stage
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Create] action
-
Endpoint URL address:
/stages
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Stages/post_stages.
- [Update] action
-
Endpoint URL address:
/stages/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Stages/put_stages_id.
- [Delete] action
-
Endpoint URL address:
/stages
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Stages/delete_stages.
-
ids:
- id
A key field. Data type: DT_I4
- order_nr
Data type: DT_I4
- name
Template: ShortText.
- active_flag
Data type: DT_BOOL
- deal_probability
Data type: DT_I4
- pipeline_id
Data type: DT_I4
- rotten_flag
Data type: DT_BOOL
- rotten_days
Template: ShortText.
- add_time
Template: ShortText.
- update_time
Template: ShortText.
- pipeline_name
Template: ShortText.
- pipeline_deal_probability
Data type: DT_BOOL
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/subscriptions/{{=item.type}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Subscriptions/post_subscriptions_recurring .
- [Update] action
-
Endpoint URL address:
/subscriptions/{{=item.type}}/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Subscriptions/put_subscriptions_recurring_id.
- [Delete] action
-
Endpoint URL address:
/subscriptions/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Subscriptions/delete_subscriptions_id.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- deal_id
Data type: DT_I4
- currency
Template: ShortText.
- description
Template: ShortText.
- cadence_type
Template: ShortText.
- cycles_count
Data type: DT_I4
- cycle_amount
Data type: DT_R8
- start_date
Template: DateTime.
- infinite
Data type: DT_BOOL
- payments
Field components:
- An array.
- Contains the following components: amount, description, due_at.
- update_deal_value
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/teams
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Teams/get_teams.
- [Create] action
-
Endpoint URL address:
/teams
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Teams/post_teams.
- [Update] action
-
Endpoint URL address:
/teams/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Teams/put_teams_id.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- manager_id
Data type: DT_I4
- users
Field components:
- An array.
-
Uses template:
User
.
- active_flag
Data type: DT_BOOL
- deleted_flag
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users.
- [Read recent] action
-
Endpoint URL address:
/recents
.
The result is extracted from:{{=_.pluck(response.data, 'data')}}
.The action has the following user-defined parameters:
- since_timestamp: Required. Specify timestamp to retrieve changes since.
The following request parameters will be automatically processed:
-
items:
user
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Recents.
- [Read team] action
-
Endpoint URL address:
/teams/user/{{=parameters.team_id}}
.The action has the following user-defined parameters:
- team_id: Required. Specify team identifier.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Teams/get_teams_id_users.
- [Read search] action
-
Endpoint URL address:
/users/find
.The action has the following user-defined parameters:
- term: Required. Specify search term.
Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_find.
- [Create] action
-
Endpoint URL address:
/users
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users/post_users.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users/put_users_id.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- default_currency
Template: ShortText.
- locale
Template: ShortText.
Template: ShortText.
- phone
Template: ShortText.
- created
Template: DateTime. A read-only field.
- modified
Template: DateTime. A read-only field.
- lang
Data type: DT_I4
- active_flag
Data type: DT_BOOL
- is_admin
Data type: DT_I4
- last_login
Template: DateTime.
- signup_flow_variation
Template: ShortText.
- role_id
Data type: DT_I4
- has_created_company
Data type: DT_BOOL
- activated
Data type: DT_BOOL
- timezone_name
Template: ShortText.
- timezone_offset
Template: ShortText.
- icon_url
Template: ShortText.
- is_you
Data type: DT_BOOL
- followers
A read-only field. The value is gathered from
/users/{{=item.id}}/followers
address. The gathered value is processed with{{=response.data}}
expression. Field components:- An array.
-
Uses template:
Follower
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/get_webhooks.
- [Create] action
-
Endpoint URL address:
/webhooks
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/post_webhooks.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}
.Documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/delete_webhooks_id.
- id
A key field. Data type: DT_I4
- subscription_url
Template: ShortText.
- event_action
Template: ShortText.
- event_object
Template: ShortText.
- user_id
Data type: DT_I4
- http_auth_user
Template: ShortText.
- http_auth_password
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response.data}}
.
The result is paginated.The following request parameters will be automatically processed:
-
start:
{{=parameters.iterator}}
-
limit:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
start:
- [Create] action
-
The action uses POST method.
- [Update] action
-
The action uses PUT method.
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- User
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, email, has_pic, pic_hash, active_flag, value.
-
Uses template:
- Reference
Field components:
-
Uses template:
ShortText
. - Contains the following components: value, primary.
-
Uses template:
- PersonRef
Field components:
-
Uses template:
ShortText
. - Contains the following components: active_flag, name, email, phone, value.
-
Uses template:
- OrganizationRef
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, people_count, owner_id, address, active_flag, cc_email, value.
-
Uses template:
- Activity
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, subject, type, done, marked_as_done_time, org_id, person_id, due_date, due_time, duration, note, add_time, user_id, created_by_user_id, update_time, update_user_id, last_notification_time, last_notification_user_id, location, busy_flag, public_description, lead_title.
-
Uses template:
- File
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, user_id, deal_id, person_id, org_id, product_id, activity_id, log_id, add_time, update_time, file_name, file_type, file_size, active_flag, inline_flag, remote_location, remote_id, cid, s3_bucket, mail_message_id, mail_template_id, deal_name, person_name, people_name, org_name, product_name, url, name, description.
-
Uses template:
- Person
Field components:
-
Uses template:
User
. - Contains the following components: id, company_id, owner_id, org_id, name, first_name, last_name, related_open_deals_count, closed_deals_count, related_closed_deals_count, participant_open_deals_count, participant_closed_deals_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, active_flag, phone, email, first_char, update_time, add_time, visible_to, picture_id, sync_needed, next_activity_date, next_activity_time, next_activity_id, last_activity_id, last_activity_date, last_incoming_mail_time, last_outgoing_mail_time, label, service_reference, org_name, owner_name, cc_email.
-
Uses template:
- Product
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, owner_id, code, selectable, visible_to, price, unit, tax, category, description, unit_prices.
-
Uses template:
- Deal
Field components:
-
Uses template:
DateTime
. - Contains the following components: id, active, deleted, next_activity_id, last_activity_id, pipeline_id, first_won_time, products_count, files_count, notes_count, followers_count, participants_count, stage_order_nr, person_name, org_name, next_activity_subject, next_activity_type, next_activity_duration, next_activity_note, formatted_value, formatted_weighted_value, rotten_time, owner_name, cc_email, org_hidden, person_hidden.
-
Uses template:
- Follower
Field components:
-
Uses template:
DateTime
. - Contains the following components: id, user_id, add_time.
-
Uses template:
- CustomField
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, key, name, order_nr, picklist_data, field_type, add_time, update_time, last_updated_by_user_id, active_flag, edit_flag, index_visible_flag, details_visible_flag, add_visible_flag, important_flag, bulk_edit_allowed, searchable_flag, filtering_allowed, sortable_flag, use_field, link, mandatory_flag, options.
-
Uses template:
What's New
- Fixed: Reading of custom fields value (Thank you, Michael).
- Fixed: Various fixes (Thank you, Ravi).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.