Pipedrive (API Token)
Manage your sales pipeline and customer relationships with Pipedrive using API token authentication.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 87 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_activities | Returns data about all activities. | filter_id (integer) ids (string) owner_id (integer) deal_id (integer) lead_id (string) person_id (integer) org_id (integer) done (boolean) updated_since (string) updated_until (string) sort_by (string) sort_direction (string) include_fields (string) limit (integer) cursor (string) |
| post_activities | Adds a new activity. | data: { . subject (string) . type (string) . owner_id (integer) . deal_id (integer) . lead_id (string) . person_id (integer) . org_id (integer) . project_id (integer) . due_date (string) . due_time (string) . duration (string) . busy (boolean) . done (boolean) . location (object) . participants (array) . attendees (array) . public_description (string) . priority (integer) . note (string) } (object) required |
| delete_activities_by_id | Marks an activity as deleted. After 30 days, the activity will be permanently deleted. | id (integer) |
| get_activities_by_id | Returns the details of a specific activity. | id (integer) include_fields (string) |
| patch_activities_by_id | Updates the properties of an activity. | id (integer) data: { . subject (string) . type (string) . owner_id (integer) . deal_id (integer) . lead_id (string) . person_id (integer) . org_id (integer) . project_id (integer) . due_date (string) . due_time (string) . duration (string) . busy (boolean) . done (boolean) . location (object) . participants (array) . attendees (array) . public_description (string) . priority (integer) . note (string) } (object) required |
| get_deals | Returns data about all not archived deals. | filter_id (integer) ids (string) owner_id (integer) person_id (integer) org_id (integer) pipeline_id (integer) stage_id (integer) status (string) updated_since (string) updated_until (string) sort_by (string) sort_direction (string) include_fields (string) custom_fields (string) limit (integer) cursor (string) |
| post_deals | Adds a new deal. | data: { . title (string) . owner_id (integer) . person_id (integer) . org_id (integer) . pipeline_id (integer) . stage_id (integer) . value (number) . currency (string) . is_deleted (boolean) . is_archived (boolean) . archive_time (string) . status (string) . probability (number) . lost_reason (string) . visible_to (integer) . close_time (string) . won_time (string) . lost_time (string) . expected_close_date (string) . label_ids (array) . custom_fields (object) } (object) required |
| get_deals_archived | Returns data about all archived deals. | filter_id (integer) ids (string) owner_id (integer) person_id (integer) org_id (integer) pipeline_id (integer) stage_id (integer) status (string) updated_since (string) updated_until (string) sort_by (string) sort_direction (string) include_fields (string) custom_fields (string) limit (integer) cursor (string) |
| delete_deals_by_id | Marks a deal as deleted. After 30 days, the deal will be permanently deleted. | id (integer) |
| get_deals_by_id | Returns the details of a specific deal. | id (integer) include_fields (string) custom_fields (string) |
| patch_deals_by_id | Updates the properties of a deal. | id (integer) data: { . title (string) . owner_id (integer) . person_id (integer) . org_id (integer) . pipeline_id (integer) . stage_id (integer) . value (number) . currency (string) . is_deleted (boolean) . is_archived (boolean) . archive_time (string) . status (string) . probability (number) . lost_reason (string) . visible_to (integer) . close_time (string) . won_time (string) . lost_time (string) . expected_close_date (string) . label_ids (array) . custom_fields (object) } (object) required |
| get_deals_by_id_followers | Lists users who are following the deal. | id (integer) limit (integer) cursor (string) |
| post_deals_by_id_followers | Adds a user as a follower to the deal. | id (integer) data: { . user_id (integer) } (object) required |
| get_deals_by_id_followers_changelog | Lists changelogs about users have followed the deal. | id (integer) limit (integer) cursor (string) |
| delete_deals_by_id_followers_by_follower_id | Deletes a user follower from the deal. | id (integer) follower_id (integer) |
| get_deals_products | Returns data about products attached to deals | deal_ids (array) required cursor (string) limit (integer) sort_by (string) sort_direction (string) |
| get_deals_search | Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of a href='https://developers.pipedrive.com/docs/api/v1/ItemSearch searchItem'/v1/itemSearch/a with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID. | term (string) required fields (string) exact_match (boolean) person_id (integer) organization_id (integer) status (string) include_fields (string) limit (integer) cursor (string) |
| get_deals_by_id_products | Lists products attached to a deal. | id (integer) cursor (string) limit (integer) sort_by (string) sort_direction (string) |
| post_deals_by_id_products | Adds a product to a deal, creating a new item called a deal-product. | id (integer) data (undefined) required |
| delete_deals_by_id_products | Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request. | id (integer) ids (string) |
| patch_deals_by_id_products_by_product_attachment_id | Updates the details of the product that has been attached to a deal. | id (integer) product_attachment_id (integer) data (undefined) required |
| delete_deals_by_id_products_by_product_attachment_id | Deletes a product attachment from a deal, using the product_attachment_id. | id (integer) product_attachment_id (integer) |
| post_deals_by_id_products_bulk | Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request. | id (integer) data: { . data (array) } (object) required |
| get_deals_by_id_discounts | Lists discounts attached to a deal. | id (integer) |
| post_deals_by_id_discounts | Adds a discount to a deal changing, the deal value if the deal has one-time products attached. | id (integer) data (undefined) required |
| patch_deals_by_id_discounts_by_discount_id | Edits a discount added to a deal, changing the deal value if the deal has one-time products attached. | id (integer) discount_id (string) data (undefined) required |
| delete_deals_by_id_discounts_by_discount_id | Removes a discount from a deal, changing the deal value if the deal has one-time products attached. | id (integer) discount_id (string) |
| get_deals_installments | Lists installments attached to a list of deals. Only available in Growth and above plans. | deal_ids (array) required cursor (string) limit (integer) sort_by (string) sort_direction (string) |
| post_deals_by_id_installments | Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans. | id (integer) data (undefined) required |
| patch_deals_by_id_installments_by_installment_id | Edits an installment added to a deal. Only available in Growth and above plans. | id (integer) installment_id (integer) data (undefined) required |
| delete_deals_by_id_installments_by_installment_id | Removes an installment from a deal. Only available in Growth and above plans. | id (integer) installment_id (integer) |
| post_deals_by_id_convert_lead | Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities notes, files, emails, activities, ... are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the | id (integer) |
| get_deals_by_id_convert_status_by_conversion_id | Returns information about the conversion. Status is always present and its value not_started, running, completed, failed, rejected represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days. | id (integer) conversion_id (string) |
| get_persons | Returns data about all persons. Fields ims, postal_address, notes, birthday, and job_title are only included if contact sync is enabled for the company. | filter_id (integer) ids (string) owner_id (integer) org_id (integer) updated_since (string) updated_until (string) sort_by (string) sort_direction (string) include_fields (string) custom_fields (string) limit (integer) cursor (string) |
| post_persons | Adds a new person. If the company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also accept and return the marketing_status field. | data: { . name (string) . owner_id (integer) . org_id (integer) . add_time (string) . update_time (string) . emails (array) . phones (array) . visible_to (integer) . label_ids (array) . marketing_status (string) } (object) required |
| delete_persons_by_id | Marks a person as deleted. After 30 days, the person will be permanently deleted. | id (integer) |
| get_persons_by_id | Returns the details of a specific person. Fields ims, postal_address, notes, birthday, and job_title are only included if contact sync is enabled for the company. | id (integer) include_fields (string) custom_fields (string) |
| patch_persons_by_id | Updates the properties of a person. brIf the company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also accept and return the marketing_status field. | id (integer) data: { . name (string) . owner_id (integer) . org_id (integer) . add_time (string) . update_time (string) . emails (array) . phones (array) . visible_to (integer) . label_ids (array) . marketing_status (string) } (object) required |
| get_persons_by_id_followers | Lists users who are following the person. | id (integer) limit (integer) cursor (string) |
| post_persons_by_id_followers | Adds a user as a follower to the person. | id (integer) data: { . user_id (integer) } (object) required |
| get_persons_by_id_followers_changelog | Lists changelogs about users have followed the person. | id (integer) limit (integer) cursor (string) |
| delete_persons_by_id_followers_by_follower_id | Deletes a user follower from the person. | id (integer) follower_id (integer) |
| get_organizations | Returns data about all organizations. | filter_id (integer) ids (string) owner_id (integer) updated_since (string) updated_until (string) sort_by (string) sort_direction (string) include_fields (string) custom_fields (string) limit (integer) cursor (string) |
| post_organizations | Adds a new organization. | data: { . name (string) . owner_id (integer) . add_time (string) . update_time (string) . visible_to (integer) . label_ids (array) . address (object) . custom_fields (object) } (object) required |
| delete_organizations_by_id | Marks a organization as deleted. After 30 days, the organization will be permanently deleted. | id (integer) |
| get_organizations_by_id | Returns the details of a specific organization. | id (integer) include_fields (string) custom_fields (string) |
| patch_organizations_by_id | Updates the properties of a organization. | id (integer) data: { . name (string) . owner_id (integer) . add_time (string) . update_time (string) . visible_to (integer) . label_ids (array) . address (object) . custom_fields (object) } (object) required |
| get_organizations_by_id_followers | Lists users who are following the organization. | id (integer) limit (integer) cursor (string) |
| post_organizations_by_id_followers | Adds a user as a follower to the organization. | id (integer) data: { . user_id (integer) } (object) required |
| get_organizations_by_id_followers_changelog | Lists changelogs about users have followed the organization. | id (integer) limit (integer) cursor (string) |
| delete_organizations_by_id_followers_by_follower_id | Deletes a user follower from the organization. | id (integer) follower_id (integer) |
| get_products | Returns data about all products. | owner_id (integer) ids (string) filter_id (integer) cursor (string) limit (integer) sort_by (string) sort_direction (string) custom_fields (string) |
| post_products | Adds a new product to the Products inventory. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-product' target='_blank' rel='noopener noreferrer'adding a product/a. | data (undefined) required |
| get_products_by_id_followers | Lists users who are following the product. | id (integer) limit (integer) cursor (string) |
| post_products_by_id_followers | Adds a user as a follower to the product. | id (integer) data: { . user_id (integer) } (object) required |
| get_products_by_id_followers_changelog | Lists changelogs about users have followed the product. | id (integer) limit (integer) cursor (string) |
| delete_products_by_id_followers_by_follower_id | Deletes a user follower from the product. | id (integer) follower_id (integer) |
| get_products_search | Searches all products by name, code and/or custom fields. This endpoint is a wrapper of a href='https://developers.pipedrive.com/docs/api/v1/ItemSearch searchItem'/v1/itemSearch/a with a narrower OAuth scope. | term (string) required fields (string) exact_match (boolean) include_fields (string) limit (integer) cursor (string) |
| delete_products_by_id | Marks a product as deleted. After 30 days, the product will be permanently deleted. | id (integer) |
| get_products_by_id | Returns data about a specific product. | id (integer) |
| patch_products_by_id | Updates product data. | id (integer) data (undefined) required |
| get_products_by_id_variations | Returns data about all product variations. | id (integer) cursor (string) limit (integer) |
| post_products_by_id_variations | Adds a new product variation. | id (integer) data: { . name (string) . prices (array) } (object) required |
| patch_products_by_id_variations_by_product_variation_id | Updates product variation data. | id (integer) product_variation_id (integer) data: { . name (string) . prices (array) } (object) required |
| delete_products_by_id_variations_by_product_variation_id | Deletes a product variation. | id (integer) product_variation_id (integer) |
| get_products_by_id_images | Retrieves the image of a product. The public URL has a limited lifetime of 7 days. | id (integer) |
| post_products_by_id_images | Uploads an image for a product. | id (integer) |
| put_products_by_id_images | Updates the image of a product. | id (integer) |
| delete_products_by_id_images | Deletes the image of a product. | id (integer) |
| get_leads_search | Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of a href='https://developers.pipedrive.com/docs/api/v1/ItemSearch searchItem'/v1/itemSearch/a with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID. | term (string) required fields (string) exact_match (boolean) person_id (integer) organization_id (integer) include_fields (string) limit (integer) cursor (string) |
| post_leads_by_id_convert_deal | Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities notes, files, emails, activities, ... are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the a href='https://developers.pipedrive.com/docs/api/v1/Leads getLeadConversionStatus'/api/v2/leads/lead_id/convert/status/con | id (string) data: { . stage_id (integer) . pipeline_id (integer) } (object) required |
| get_leads_by_id_convert_status_by_conversion_id | Returns data about the conversion. Status is always present and its value not_started, running, completed, failed, rejected represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days. | id (string) conversion_id (string) |
| get_organizations_search | Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of a href='https://developers.pipedrive.com/docs/api/v1/ItemSearch searchItem'/v1/itemSearch/a with a narrower OAuth scope. | term (string) required fields (string) exact_match (boolean) limit (integer) cursor (string) |
| get_persons_search | Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of a href='https://developers.pipedrive.com/docs/api/v1/ItemSearch searchItem'/v1/itemSearch/a with a narrower OAuth scope. Found persons can be filtered by organization ID. | term (string) required fields (string) exact_match (boolean) organization_id (integer) include_fields (string) limit (integer) cursor (string) |
| get_item_search | Performs a search from your choice of item types and fields. | term (string) required item_types (string) fields (string) search_for_related_items (boolean) exact_match (boolean) include_fields (string) limit (integer) cursor (string) |
| get_item_search_field | Performs a search from the values of a specific field. Results can either be the distinct values of the field useful for searching autocomplete field values, or the IDs of actual items deals, leads, persons, organizations or products. | term (string) required entity_type (string) required match (string) field (string) required limit (integer) cursor (string) |
| get_stages | Returns data about all stages. | pipeline_id (integer) sort_by (string) sort_direction (string) limit (integer) cursor (string) |
| post_stages | Adds a new stage, returns the ID upon success. | data: { . name (string) . pipeline_id (integer) . deal_probability (integer) . is_deal_rot_enabled (boolean) . days_to_rotten (integer) } (object) required |
| delete_stages_by_id | Marks a stage as deleted. | id (integer) |
| get_stages_by_id | Returns data about a specific stage. | id (integer) |
| patch_stages_by_id | Updates the properties of a stage. | id (integer) data: { . name (string) . pipeline_id (integer) . deal_probability (integer) . is_deal_rot_enabled (boolean) . days_to_rotten (integer) } (object) required |
| get_pipelines | Returns data about all pipelines. | sort_by (string) sort_direction (string) limit (integer) cursor (string) |
| post_pipelines | Adds a new pipeline. | data: { . name (string) . is_deal_probability_enabled (boolean) } (object) required |
| delete_pipelines_by_id | Marks a pipeline as deleted. | id (integer) |
| get_pipelines_by_id | Returns data about a specific pipeline. | id (integer) |
| patch_pipelines_by_id | Updates the properties of a pipeline. | id (integer) data: { . name (string) . is_deal_probability_enabled (boolean) } (object) required |
| get_users_by_id_followers | Lists users who are following the user. | id (integer) limit (integer) cursor (string) |