Pipedrive

Manage your sales pipeline and customer relationships with Pipedrive.

Authentication

This connector uses OAuth 2.0 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 362 actions:

Action	Purpose	Parameters
delete_activities	Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Activities deleteActivity' target='_blank' rel='noopener noreferrer'DELETE /api/v2/activities/id/a instead.	ids (string) required
get_activities	Returns all activities assigned to a particular user.	user_id (integer) filter_id (integer) type (string) limit (integer) start (integer) start_date (string) end_date (string) done (number)
post_activities	Adds a new activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization depending on the supplied data. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-an-activity' target='_blank' rel='noopener noreferrer'adding an activity/a. br / br / Starting from 30.09.2024, activity attendees will receive updates only if t	data (undefined) required
get_activities_collection	Returns all activities. Please note that only global admins those with global permissions can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions a href='https://support.pipedrive.com/en/article/global-user-management' target='_blank' rel='noopener noreferrer'here/a. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Activities getActivities' target='_blank' rel='noopener noreferrer	cursor (string) limit (integer) since (string) until (string) user_id (integer) done (boolean) type (string)
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)
put_activities_by_id	Updates an activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization depending on the supplied data. br / br / Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync	id (integer) data (undefined) required
get_activity_fields	Returns all activity fields.	No parameters
delete_activity_types	Marks multiple activity types as deleted.	ids (string) required
get_activity_types	Returns all activity types.	No parameters
post_activity_types	Adds a new activity type.	data: { . name (string) . icon_key (string) . color (string) } (object) required
delete_activity_types_by_id	Marks an activity type as deleted.	id (integer)
put_activity_types_by_id	Updates an activity type.	id (integer) data: { . name (string) . icon_key (string) . color (string) . order_nr (integer) } (object) required
get_billing_subscriptions_addons	Returns the add-ons for a single company.	No parameters
post_call_logs	Adds a new call log.	data: { . user_id (integer) . activity_id (integer) . subject (string) . duration (string) . outcome (string) . from_phone_number (string) . to_phone_number (string) . start_time (string) . end_time (string) . person_id (integer) . org_id (integer) . deal_id (integer) . lead_id (string) . note (string) } (object) required
get_call_logs	Returns all call logs assigned to a particular user.	start (integer) limit (integer)
delete_call_logs_by_id	Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.	id (string)
get_call_logs_by_id	Returns details of a specific call log.	id (string)
post_call_logs_by_id_recordings	Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.	id (string)
post_channels	Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extensionhttps://pipedrive.readme.io/docs/messaging-app-extension.	data: { . name (string) . provider_channel_id (string) . avatar_url (string) . template_support (boolean) . provider_type (string) } (object) required
delete_channels_by_id	Deletes an existing messenger’s channel and all related entities conversations and messages. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extensionhttps://pipedrive.readme.io/docs/messaging-app-extension.	id (string)
post_channels_messages_receive	Adds a message to a conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extensionhttps://pipedrive.readme.io/docs/messaging-app-extension.	data: { . id (string) . channel_id (string) . sender_id (string) . conversation_id (string) . message (string) . status (string) . created_at (string) . reply_by (string) . conversation_link (string) . attachments (array) } (object) required
delete_channels_by_channel_id_conversations_by_conversation_id	Deletes an existing conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extensionhttps://pipedrive.readme.io/docs/messaging-app-extension.	channel-id (string) conversation-id (string)
get_currencies	Returns all supported currencies in given account which should be used when saving monetary values with other objects. The code parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.	term (string)
get_deals	Returns all not archived deals. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/getting-all-deals' target='_blank' rel='noopener noreferrer'getting all deals/a.	user_id (integer) filter_id (integer) stage_id (integer) status (string) start (integer) limit (integer) sort (string) owned_by_you (number)
post_deals	Adds a new deal. All deals created through the Pipedrive API will have a origin set to API. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for key values. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/creating-a-deal' target='_bl	data (undefined) required
delete_deals	Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Deals deleteDeal' target='_blank' rel='noopener noreferrer'DELETE /api/v2/deals/id/a instead.	ids (string) required
get_deals_archived	Returns all archived deals.	user_id (integer) filter_id (integer) person_id (integer) org_id (integer) product_id (integer) pipeline_id (integer) stage_id (integer) status (string) start (integer) limit (integer) sort (string) owned_by_you (number)
get_deals_collection	Returns all deals. Please note that only global admins those with global permissions can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions a href='https://support.pipedrive.com/en/article/global-user-management' target='_blank' rel='noopener noreferrer'here/a. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Deals getDeals' target='_blank' rel='noopener noreferrer'GET /api/v2/de	cursor (string) limit (integer) since (string) until (string) user_id (integer) stage_id (integer) status (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) start (integer) limit (integer)
get_deals_summary	Returns a summary of all not archived deals.	status (string) filter_id (integer) user_id (integer) pipeline_id (integer) stage_id (integer)
get_deals_summary_archived	Returns a summary of all archived deals.	status (string) filter_id (integer) user_id (integer) pipeline_id (integer) stage_id (integer)
get_deals_timeline	Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField field_key — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given field_key.	start_date (string) required interval (string) required amount (integer) required field_key (string) required user_id (integer) pipeline_id (integer) filter_id (integer) exclude_deals (number) totals_convert_currency (string)
get_deals_timeline_archived	Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField field_key — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given field_key.	start_date (string) required interval (string) required amount (integer) required field_key (string) required user_id (integer) pipeline_id (integer) filter_id (integer) exclude_deals (number) totals_convert_currency (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. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of dealFields. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/getting-details-of-a-deal' target='_blank' rel='noopener noreferrer'getting details of a de	id (integer)
put_deals_by_id	Updates the properties of a deal. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/updating-a-deal' target='_blank' rel='noopener noreferrer'updating a deal/a.	id (integer) data (object) required
get_deals_by_id_activities	Lists activities associated with a deal. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Activities getActivities' target='_blank' rel='noopener noreferrer'GET /api/v2/activities?deal_id=id/a instead.	id (integer) start (integer) limit (integer) done (number) exclude (string)
get_deals_by_id_changelog	Lists updates about field values of a deal.	id (integer) cursor (string) limit (integer)
post_deals_by_id_duplicate	Duplicates a deal.	id (integer)
get_deals_by_id_files	Lists files associated with a deal.	id (integer) start (integer) limit (integer) sort (string)
get_deals_by_id_flow	Lists updates about a deal.	id (integer) start (integer) limit (integer) all_changes (string) items (string)
get_deals_by_id_participants_changelog	List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on a href='https://pipedrive.readme.io/docs/core-api-concepts-pagination' target='_blank' rel='noopener noreferrer'pagination/a.	id (integer) limit (integer) cursor (string)
get_deals_by_id_followers	Lists the followers of a deal.	id (integer)
post_deals_by_id_followers	Adds a follower to a deal.	id (integer) data: { . user_id (integer) } (object) required
delete_deals_by_id_followers_by_follower_id	Deletes a follower from a deal.	id (integer) follower_id (integer)
get_deals_by_id_mail_messages	Lists mail messages associated with a deal.	id (integer) start (integer) limit (integer)
put_deals_by_id_merge	Merges a deal with another deal. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/merging-two-deals' target='_blank' rel='noopener noreferrer'merging two deals/a.	id (integer) data: { . merge_with_id (integer) } (object) required
get_deals_by_id_participants	Lists the participants associated with a deal.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also return the data.marketing_status field.	id (integer) start (integer) limit (integer)
post_deals_by_id_participants	Adds a participant to a deal.	id (integer) data: { . person_id (integer) } (object) required
delete_deals_by_id_participants_by_deal_participant_id	Deletes a participant from a deal.	id (integer) deal_participant_id (integer)
get_deals_by_id_permitted_users	Lists the users permitted to access a deal.	id (integer)
get_deals_by_id_persons	Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also return the data.marketing_status field. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Persons getPersons' target='_blank' rel='noopener noreferrer'GET /api/v2/persons?deal_id=id	id (integer) start (integer) limit (integer)
get_deals_by_id_products	Lists products attached to a deal.	id (integer) start (integer) limit (integer) include_product_data (number)
post_deals_by_id_products	Adds a product to a deal, creating a new item called a deal-product.	id (integer) data (object) required
put_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 (object) required
delete_deals_by_id_products_by_product_attachment_id	Deletes a product attachment from a deal, using the product_attachment_id Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled	id (integer) product_attachment_id (integer)
get_deal_fields	Returns data about all deal fields.	start (integer) limit (integer)
post_deal_fields	Adds a new deal field. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-new-custom-field' target='_blank' rel='noopener noreferrer'adding a new custom field/a.	data (undefined) required
delete_deal_fields	Marks multiple deal fields as deleted.	ids (string) required
get_deal_fields_by_id	Returns data about a specific deal field.	id (integer)
delete_deal_fields_by_id	Marks a field as deleted. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/deleting-a-custom-field' target='_blank' rel='noopener noreferrer'deleting a custom field/a.	id (integer)
put_deal_fields_by_id	Updates a deal field. For more information, see the tutorial for a href=' https://pipedrive.readme.io/docs/updating-custom-field-value ' target='_blank' rel='noopener noreferrer'updating custom fields' values/a.	id (integer) data: { . name (string) . options (array) . add_visible_flag (boolean) } (object) required
get_files	Returns data about all files.	start (integer) limit (integer) sort (string)
post_files	Lets you upload a file and associate it with a deal, person, organization, activity, product or lead. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-file' target='_blank' rel='noopener noreferrer'adding a file/a.	No parameters
post_files_remote	Creates a new empty file in the remote location googledrive that will be linked to the item you supply. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-remote-file' target='_blank' rel='noopener noreferrer'adding a remote file/a.	No parameters
post_files_remote_link	Links an existing remote file googledrive to the item you supply. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-remote-file' target='_blank' rel='noopener noreferrer'adding a remote file/a.	No parameters
delete_files_by_id	Marks a file as deleted. After 30 days, the file will be permanently deleted.	id (integer)
get_files_by_id	Returns data about a specific file.	id (integer)
put_files_by_id	Updates the properties of a file.	id (integer)
get_files_by_id_download	Initializes a file download.	id (integer)
delete_filters	Marks multiple filters as deleted.	ids (string) required
get_filters	Returns data about all filters.	type (string)
post_filters	Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work yet but the syntax supports introducing them in future. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-filter' target='_blank' rel	data: { . name (string) . conditions (object) . type (string) } (object) required
get_filters_helpers	Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to a href='/docs/api/v1/Filters addFilter'add/a or a href='/docs/api/v1/Filters updateFilter'update/a filters. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-filter' target='_blank' rel='noopener noreferrer'adding a filter/a.	No parameters
delete_filters_by_id	Marks a filter as deleted.	id (integer)
get_filters_by_id	Returns data about a specific filter. Note that this also returns the condition lines of the filter.	id (integer)
put_filters_by_id	Updates an existing filter.	id (integer) data: { . name (string) . conditions (object) } (object) required
post_goals	Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.	data: { . title (string) . assignee (object) . type (object) . expected_outcome (object) . duration (object) . interval (string) } (object) required
get_goals_find	Returns data about goals based on criteria. For searching, append searchField=searchValue to the URL, where searchField can be any one of the lowest-level fields in dot-notation e.g. type.params.pipeline_id; title. searchValue should be the value you are looking for on that field. Additionally, is_active=true|false can be provided to search for only active/inactive goals. When providing period.start, period.end must also be provided and vice versa.	type.name (string) title (string) is_active (boolean) assignee.id (integer) assignee.type (string) expected_outcome.target (number) expected_outcome.tracking_metric (string) expected_outcome.currency_id (integer) type.params.pipeline_id (array) type.params.stage_id (integer) type.params.activity_type_id (array) period.start (string) period.end (string)
put_goals_by_id	Updates an existing goal.	id (string) data: { . title (string) . assignee (object) . type (object) . expected_outcome (object) . duration (object) . interval (string) } (object) required
delete_goals_by_id	Marks a goal as deleted.	id (string)
get_goals_by_id_results	Gets the progress of a goal for the specified period.	id (string) period.start (string) required period.end (string) required
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) start (integer) limit (integer)
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 field_type (string) required exact_match (boolean) field_key (string) required return_item_ids (boolean) start (integer) limit (integer)
get_leads	Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using limit and start query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom	limit (integer) start (integer) owner_id (integer) person_id (integer) organization_id (integer) filter_id (integer) sort (string)
post_leads	Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source and origin set to API. Here's the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-lead' target='_blank' rel='noopener noreferrer'adding a lead/a. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the	data: { . title (string) . owner_id (integer) . label_ids (array) . person_id (integer) . organization_id (integer) . value (object) . expected_close_date (string) . visible_to (string) . was_seen (boolean) . origin_id (string) . channel (integer) . channel_id (string) } (object) required
get_leads_archived	Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using limit and start query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fiel	limit (integer) start (integer) owner_id (integer) person_id (integer) organization_id (integer) filter_id (integer) sort (string)
get_leads_by_id	Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.	id (string)
patch_leads_by_id	Updates one or more properties of a lead. Only properties included in the request will be updated. Send null to unset a property applicable for example for value, person_id or organization_id. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inh	id (string) data: { . title (string) . owner_id (integer) . label_ids (array) . person_id (integer) . organization_id (integer) . is_archived (boolean) . value (object) . expected_close_date (string) . visible_to (string) . was_seen (boolean) . channel (integer) . channel_id (string) } (object) required
delete_leads_by_id	Deletes a specific lead.	id (string)
get_leads_by_id_permitted_users	Lists the users permitted to access a lead.	id (string)
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) start (integer) limit (integer)
get_lead_fields	Returns data about all lead fields.	start (integer) limit (integer)
get_lead_labels	Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.	No parameters
post_lead_labels	Creates a lead label.	data: { . name (string) . color (string) } (object) required
patch_lead_labels_by_id	Updates one or more properties of a lead label. Only properties included in the request will be updated.	id (string) data: { . name (string) . color (string) } (object) required
delete_lead_labels_by_id	Deletes a specific lead label.	id (string)
get_lead_sources	Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source API assigned.	No parameters
get_legacy_teams	Returns data about teams within the company.	order_by (string) skip_users (number)
post_legacy_teams	Adds a new team to the company and returns the created object.	data: { . name (string) . description (string) . manager_id (integer) . users (array) } (object) required
get_legacy_teams_by_id	Returns data about a specific team.	id (integer) skip_users (number)
put_legacy_teams_by_id	Updates an existing team and returns the updated object.	id (integer) data (undefined) required
get_legacy_teams_by_id_users	Returns a list of all user IDs within a team.	id (integer)
post_legacy_teams_by_id_users	Adds users to an existing team.	id (integer) data: { . users (array) } (object) required
delete_legacy_teams_by_id_users	Deletes users from an existing team.	id (integer) data: { . users (array) } (object) required
get_legacy_teams_user_by_id	Returns data about all teams which have the specified user as a member.	id (integer) order_by (string) skip_users (number)
get_mailbox_mail_messages_by_id	Returns data about a specific mail message.	id (integer) include_body (number)
get_mailbox_mail_threads	Returns mail threads in a specified folder ordered by the most recent message within.	folder (string) required start (integer) limit (integer)
delete_mailbox_mail_threads_by_id	Marks a mail thread as deleted.	id (integer)
get_mailbox_mail_threads_by_id	Returns a specific mail thread.	id (integer)
put_mailbox_mail_threads_by_id	Updates the properties of a mail thread.	id (integer)
get_mailbox_mail_threads_by_id_mail_messages	Returns all the mail messages inside a specified mail thread.	id (integer)
post_meetings_user_provider_links	A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent.	data: { . user_provider_id (string) . user_id (integer) . company_id (integer) . marketplace_client_id (string) } (object) required
delete_meetings_user_provider_links_by_id	A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.	id (string)
get_notes	Returns all notes.	user_id (integer) lead_id (string) deal_id (integer) person_id (integer) org_id (integer) project_id (integer) start (integer) limit (integer) sort (string) start_date (string) end_date (string) pinned_to_lead_flag (number) pinned_to_deal_flag (number) pinned_to_organization_flag (number) pinned_to_person_flag (number) pinned_to_project_flag (number)
post_notes	Adds a new note.	data (undefined) required
delete_notes_by_id	Deletes a specific note.	id (integer)
get_notes_by_id	Returns details about a specific note.	id (integer)
put_notes_by_id	Updates a note.	id (integer) data (object) required
get_notes_by_id_comments	Returns all comments associated with a note.	id (integer) start (integer) limit (integer)
post_notes_by_id_comments	Adds a new comment to a note.	id (integer) data: { . content (string) } (object) required
get_notes_by_id_comments_by_comment_id	Returns the details of a comment.	id (integer) commentId (string)
put_notes_by_id_comments_by_comment_id	Updates a comment related to a note.	id (integer) commentId (string) data: { . content (string) } (object) required
delete_notes_by_id_comments_by_comment_id	Deletes a comment.	id (integer) commentId (string)
get_note_fields	Returns data about all note fields.	No parameters
get_oauth_authorize	Authorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf. This step is necessary to implement only when you allow app installation outside of the Marketplace.	client_id (string) required redirect_uri (string) required state (string)
post_oauth_token	After the customer has confirmed the app installation, you will need to exchange the authorization_code to a pair of access and refresh tokens. Using an access token, you can access the user's data through the API.	Authorization (string) required
post_oauth_token	After the customer has confirmed the app installation, you will need to exchange the authorization_code to a pair of access and refresh tokens. Using an access token, you can access the user's data through the API.	Authorization (string) required
delete_organizations	Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Organizations deleteOrganization' target='_blank' rel='noopener noreferrer'DELETE /api/v2/organizations/id/a instead.	ids (string) required
get_organizations	Returns all organizations.	user_id (integer) filter_id (integer) first_char (string) start (integer) limit (integer) sort (string)
post_organizations	Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for key values. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-an-organization' target='_blank' rel='noopener noreferrer'adding an organization	data (undefined) required
get_organizations_collection	Returns all organizations. Please note that only global admins those with global permissions can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions a href='https://support.pipedrive.com/en/article/global-user-management' target='_blank' rel='noopener noreferrer'here/a. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Organizations getOrganizations' target='_blank' rel='noopener n	cursor (string) limit (integer) since (string) until (string) owner_id (integer) first_char (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) start (integer) limit (integer)
delete_organizations_by_id	Marks an organization as deleted. After 30 days, the organization will be permanently deleted.	id (integer)
get_organizations_by_id	Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of organizationFields.	id (integer)
put_organizations_by_id	Updates the properties of an organization.	id (integer) data (undefined) required
get_organizations_by_id_activities	Lists activities associated with an organization. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Activities getActivities' target='_blank' rel='noopener noreferrer'GET /api/v2/activities?org_id=id/a instead.	id (integer) start (integer) limit (integer) done (number) exclude (string)
get_organizations_by_id_changelog	Lists updates about field values of an organization.	id (integer) cursor (string) limit (integer)
get_organizations_by_id_deals	Lists deals associated with an organization. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Deals getDeals' target='_blank' rel='noopener noreferrer'GET /api/v2/deals?org_id=id/a instead.	id (integer) start (integer) limit (integer) status (string) sort (string) only_primary_association (number)
get_organizations_by_id_files	Lists files associated with an organization.	id (integer) start (integer) limit (integer) sort (string)
get_organizations_by_id_flow	Lists updates about an organization.	id (integer) start (integer) limit (integer) all_changes (string) items (string)
get_organizations_by_id_followers	Lists the followers of an organization.	id (integer)
post_organizations_by_id_followers	Adds a follower to an organization.	id (integer) data: { . user_id (integer) } (object) required
delete_organizations_by_id_followers_by_follower_id	Deletes a follower from an organization. You can retrieve the follower_id from the a href='https://developers.pipedrive.com/docs/api/v1/Organizations getOrganizationFollowers'List followers of an organization/a endpoint.	id (integer) follower_id (integer)
get_organizations_by_id_mail_messages	Lists mail messages associated with an organization.	id (integer) start (integer) limit (integer)
put_organizations_by_id_merge	Merges an organization with another organization. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/merging-two-organizations' target='_blank' rel='noopener noreferrer'merging two organizations/a.	id (integer) data: { . merge_with_id (integer) } (object) required
get_organizations_by_id_permitted_users	List users permitted to access an organization.	id (integer)
get_organizations_by_id_persons	Lists persons associated with an organization.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also return the data.marketing_status field. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Persons getPersons' target='_blank' rel='noopener noreferrer'GET /api/v2/persons?org_id=id/a instead.	id (integer) start (integer) limit (integer)
get_organization_fields	Returns data about all organization fields.	start (integer) limit (integer)
post_organization_fields	Adds a new organization field. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-new-custom-field' target='_blank' rel='noopener noreferrer'adding a new custom field/a.	data (undefined) required
delete_organization_fields	Marks multiple fields as deleted.	ids (string) required
get_organization_fields_by_id	Returns data about a specific organization field.	id (integer)
delete_organization_fields_by_id	Marks a field as deleted. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/deleting-a-custom-field' target='_blank' rel='noopener noreferrer'deleting a custom field/a.	id (integer)
put_organization_fields_by_id	Updates an organization field. For more information, see the tutorial for a href=' https://pipedrive.readme.io/docs/updating-custom-field-value ' target='_blank' rel='noopener noreferrer'updating custom fields' values/a.	id (integer) data: { . name (string) . options (array) . add_visible_flag (boolean) } (object) required
get_organization_relationships	Gets all of the relationships for a supplied organization ID.	org_id (integer) required
post_organization_relationships	Creates and returns an organization relationship.	data: { . org_id (integer) . type (string) . rel_owner_org_id (integer) . rel_linked_org_id (integer) } (object) required
delete_organization_relationships_by_id	Deletes an organization relationship and returns the deleted ID.	id (integer)
get_organization_relationships_by_id	Finds and returns an organization relationship from its ID.	id (integer) org_id (integer)
put_organization_relationships_by_id	Updates and returns an organization relationship.	id (integer) data: { . org_id (integer) . type (string) . rel_owner_org_id (integer) . rel_linked_org_id (integer) } (object) required
get_permission_sets	Returns data about all permission sets.	app (string)
get_permission_sets_by_id	Returns data about a specific permission set.	id (string)
get_permission_sets_by_id_assignments	Returns the list of assignments for a permission set.	id (string) start (integer) limit (integer)
delete_persons	Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Persons deletePerson' target='_blank' rel='noopener noreferrer'DELETE /api/v2/persons/id/a instead.	ids (string) required
get_persons	Returns all persons.	user_id (integer) filter_id (integer) first_char (string) start (integer) limit (integer) sort (string)
post_persons	Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for key values.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also accept and return the data.marketing_status field.	data (undefined) required
get_persons_collection	Returns all persons. Please note that only global admins those with global permissions can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions a href='https://support.pipedrive.com/en/article/global-user-management' target='_blank' rel='noopener noreferrer'here/a. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Persons getPersons' target='_blank' rel='noopener noreferrer'GET /api	cursor (string) limit (integer) since (string) until (string) owner_id (integer) first_char (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) start (integer) limit (integer)
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 person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of personFields.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also return the data.marketing_status field.	id (integer)
put_persons_by_id	Updates the properties of a person. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/updating-a-person' target='_blank' rel='noopener noreferrer'updating a person/a.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also accept and return the data.marketing_status field.	id (integer) data (undefined) required
get_persons_by_id_activities	Lists activities associated with a person. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Activities getActivities' target='_blank' rel='noopener noreferrer'GET /api/v2/activities?person_id=id/a instead.	id (integer) start (integer) limit (integer) done (number) exclude (string)
get_persons_by_id_changelog	Lists updates about field values of a person.	id (integer) cursor (string) limit (integer)
get_persons_by_id_deals	Lists deals associated with a person. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Deals getDeals' target='_blank' rel='noopener noreferrer'GET /api/v2/deals?person_id=id/a instead.	id (integer) start (integer) limit (integer) status (string) sort (string)
get_persons_by_id_files	Lists files associated with a person.	id (integer) start (integer) limit (integer) sort (string)
get_persons_by_id_flow	Lists updates about a person.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint's response will also include updates for the marketing_status field.	id (integer) start (integer) limit (integer) all_changes (string) items (string)
get_persons_by_id_followers	Lists the followers of a person.	id (integer)
post_persons_by_id_followers	Adds a follower to a person.	id (integer) data: { . user_id (integer) } (object) required
delete_persons_by_id_followers_by_follower_id	Deletes a follower from a person.	id (integer) follower_id (integer)
get_persons_by_id_mail_messages	Lists mail messages associated with a person.	id (integer) start (integer) limit (integer)
put_persons_by_id_merge	Merges a person with another person. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/merging-two-persons' target='_blank' rel='noopener noreferrer'merging two persons/a.	id (integer) data: { . merge_with_id (integer) } (object) required
get_persons_by_id_permitted_users	List users permitted to access a person.	id (integer)
delete_persons_by_id_picture	Deletes a person’s picture.	id (integer)
post_persons_by_id_picture	Adds a picture to a person. If a picture is already set, the old picture will be replaced. Added image or the cropping parameters supplied with the request should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.	id (integer)
get_persons_by_id_products	Lists products associated with a person.	id (integer) start (integer) limit (integer)
get_person_fields	Returns data about all person fields.brIf a company uses the Campaigns producthttps://pipedrive.readme.io/docs/campaigns-in-pipedrive-api, then this endpoint will also return the data.marketing_status field.	start (integer) limit (integer)
post_person_fields	Adds a new person field. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-new-custom-field' target='_blank' rel='noopener noreferrer'adding a new custom field/a.	data (undefined) required
delete_person_fields	Marks multiple fields as deleted.	ids (string) required
get_person_fields_by_id	Returns data about a specific person field.	id (integer)
delete_person_fields_by_id	Marks a field as deleted. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/deleting-a-custom-field' target='_blank' rel='noopener noreferrer'deleting a custom field/a.	id (integer)
put_person_fields_by_id	Updates a person field. For more information, see the tutorial for a href=' https://pipedrive.readme.io/docs/updating-custom-field-value ' target='_blank' rel='noopener noreferrer'updating custom fields' values/a.	id (integer) data: { . name (string) . options (array) . add_visible_flag (boolean) } (object) required
get_pipelines	Returns data about all pipelines.	No parameters
post_pipelines	Adds a new pipeline.	data: { . name (string) . deal_probability . order_nr (integer) . active } (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)
put_pipelines_by_id	Updates the properties of a pipeline.	id (integer) data: { . name (string) . deal_probability . order_nr (integer) . active } (object) required
get_pipelines_by_id_conversion_statistics	Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.	id (integer) start_date (string) required end_date (string) required user_id (integer)
get_pipelines_by_id_deals	Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Deals getDeals' target='_blank' rel='noopener noreferrer'GET /api/v2/deals?pipeline_id=id/a instead.	id (integer) filter_id (integer) user_id (integer) everyone (number) stage_id (integer) start (integer) limit (integer) get_summary (number) totals_convert_currency (string)
get_pipelines_by_id_movement_statistics	Returns statistics for deals movements for the given time period.	id (integer) start_date (string) required end_date (string) required user_id (integer)
get_products	Returns data about all products.	user_id (integer) filter_id (integer) ids (array) first_char (string) get_summary (boolean) start (integer) limit (integer)
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_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) start (integer) limit (integer)
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)
put_products_by_id	Updates product data.	id (integer) data (undefined) required
get_products_by_id_deals	Returns data about deals that have a product attached to it.	id (integer) start (integer) limit (integer) status (string)
get_products_by_id_files	Lists files associated with a product.	id (integer) start (integer) limit (integer) sort (string)
get_products_by_id_followers	Lists the followers of a product.	id (integer) start (integer) limit (integer)
post_products_by_id_followers	Adds a follower to a product.	id (integer) data: { . user_id (integer) } (object) required
delete_products_by_id_followers_by_follower_id	Deletes a follower from a product.	id (integer) follower_id (integer)
get_products_by_id_permitted_users	Lists users permitted to access a product.	id (integer)
delete_product_fields	Marks multiple fields as deleted.	ids (string) required
get_product_fields	Returns data about all product fields.	start (integer) limit (integer)
post_product_fields	Adds a new product field. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/adding-a-new-custom-field' target='_blank' rel='noopener noreferrer'adding a new custom field/a.	data: { . name (string) . options (array) . field_type (string) } (object) required
delete_product_fields_by_id	Marks a product field as deleted. For more information, see the tutorial for a href='https://pipedrive.readme.io/docs/deleting-a-custom-field' target='_blank' rel='noopener noreferrer'deleting a custom field/a.	id (integer)
get_product_fields_by_id	Returns data about a specific product field.	id (integer)
put_product_fields_by_id	Updates a product field. For more information, see the tutorial for a href=' https://pipedrive.readme.io/docs/updating-custom-field-value ' target='_blank' rel='noopener noreferrer'updating custom fields' values/a.	id (integer) data: { . name (string) . options (array) } (object) required
get_projects	Returns all projects. This is a cursor-paginated endpoint. For more information, please refer to our documentation on a href='https://pipedrive.readme.io/docs/core-api-concepts-pagination' target='_blank' rel='noopener noreferrer'pagination/a.	cursor (string) limit (integer) filter_id (integer) status (string) phase_id (integer) include_archived (boolean)
post_projects	Adds a new project. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys.	data (undefined) required
get_projects_by_id	Returns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of project fields.	id (integer)
put_projects_by_id	Updates a project.	id (integer) data (undefined) required
delete_projects_by_id	Marks a project as deleted.	id (integer)
post_projects_by_id_archive	Archives a project.	id (integer)
get_projects_by_id_plan	Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.	id (integer)
put_projects_by_id_plan_activities_by_activity_id	Updates an activity phase or group in a project.	id (integer) activityId (integer) data: { . phase_id (number) . group_id (number) } (object) required
put_projects_by_id_plan_tasks_by_task_id	Updates a task phase or group in a project.	id (integer) taskId (integer) data: { . phase_id (number) . group_id (number) } (object) required
get_projects_by_id_groups	Returns all active groups under a specific project.	id (integer)
get_projects_by_id_tasks	Returns tasks linked to a specific project.	id (integer)
get_projects_by_id_activities	Returns activities linked to a specific project.	id (integer)
get_projects_boards	Returns all projects boards that are not deleted.	No parameters
get_projects_boards_by_id	Returns the details of a specific project board.	id (integer)
get_projects_phases	Returns all active project phases under a specific board.	board_id (integer) required
get_projects_phases_by_id	Returns the details of a specific project phase.	id (integer)
get_project_templates	Returns all not deleted project templates. This is a cursor-paginated endpoint. For more information, please refer to our documentation on a href='https://pipedrive.readme.io/docs/core-api-concepts-pagination' target='_blank' rel='noopener noreferrer'pagination/a.	cursor (string) limit (integer)
get_project_templates_by_id	Returns the details of a specific project template.	id (integer)
get_recents	Returns data about all recent changes occurred after the given timestamp.	since_timestamp (string) required items (string) start (integer) limit (integer)
get_roles	Returns all the roles within the company.	start (integer) limit (integer)
post_roles	Adds a new role.	data: { . name (string) . parent_role_id (integer) } (object) required
delete_roles_by_id	Marks a role as deleted.	id (integer)
get_roles_by_id	Returns the details of a specific role.	id (integer)
put_roles_by_id	Updates the parent role and/or the name of a specific role.	id (integer) data: { . parent_role_id (integer) . name (string) } (object) required
delete_roles_by_id_assignments	Removes the assigned user from a role and adds to the default role.	id (integer) data: { . user_id (integer) } (object) required
get_roles_by_id_assignments	Returns all users assigned to a role.	id (integer) start (integer) limit (integer)
post_roles_by_id_assignments	Assigns a user to a role.	id (integer) data: { . user_id (integer) } (object) required
get_roles_by_id_settings	Returns the visibility settings of a specific role.	id (integer)
post_roles_by_id_settings	Adds or updates the visibility setting for a role.	id (integer) data: { . setting_key (string) . value (integer) } (object) required
get_roles_by_id_pipelines	Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the a href='https://support.pipedrive.com/en/article/visibility-groups' target='_blank' rel='noopener noreferrer'Visibility groups article/a.	id (integer) visible (boolean)
put_roles_by_id_pipelines	Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the a href='https://support.pipedrive.com/en/article/visibility-groups' target='_blank' rel='noopener noreferrer'Visibility groups article/a.	id (integer) data: { . visible_pipeline_ids (object) } (object) required
delete_stages	Marks multiple stages as deleted. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Stages deleteStage' target='_blank' rel='noopener noreferrer'DELETE /api/v2/stages/id/a instead.	ids (string) required
get_stages	Returns data about all stages.	pipeline_id (integer) start (integer) limit (integer)
post_stages	Adds a new stage, returns the ID upon success.	data: { . name (string) . pipeline_id (integer) . deal_probability (integer) . rotten_flag (boolean) . rotten_days (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)
put_stages_by_id	Updates the properties of a stage.	id (integer) data (undefined) required
get_stages_by_id_deals	Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. brThis endpoint has been deprecated. Please use a href='https://developers.pipedrive.com/docs/api/v1/Deals getDeals' target='_blank' rel='noopener noreferrer'GET /api/v2/deals?stage_id=id/a instead.	id (integer) filter_id (integer) user_id (integer) everyone (number) start (integer) limit (integer)
get_tasks	Returns all tasks. This is a cursor-paginated endpoint. For more information, please refer to our documentation on a href='https://pipedrive.readme.io/docs/core-api-concepts-pagination' target='_blank' rel='noopener noreferrer'pagination/a.	cursor (string) limit (integer) assignee_id (integer) project_id (integer) parent_task_id (integer) done (number)
post_tasks	Adds a new task.	data (undefined) required
get_tasks_by_id	Returns the details of a specific task.	id (integer)
put_tasks_by_id	Updates a task.	id (integer) data (object) required
delete_tasks_by_id	Marks a task as deleted. If the task has subtasks then those will also be deleted.	id (integer)
get_users	Returns data about all users within the company.	No parameters
post_users	Adds a new user to the company, returns the ID upon success.	data: { . email (string) . access (array) . active_flag (boolean) } (object) required
get_users_find	Finds users by their name.	term (string) required search_by_email (number)
get_users_me	Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the locale property means 'Date/number format' in the Pipedrive account settings, not the chosen language.	No parameters
get_users_by_id	Returns data about a specific user within the company.	id (integer)
put_users_by_id	Updates the properties of a user. Currently, only active_flag can be updated.	id (integer) data: { . active_flag (boolean) } (object) required
get_users_by_id_followers	Lists the followers of a specific user.	id (integer)
get_users_by_id_permissions	Lists aggregated permissions over all assigned permission sets for a user.	id (integer)
get_users_by_id_role_assignments	Lists role assignments for a user.	id (integer) start (integer) limit (integer)
get_users_by_id_role_settings	Lists the settings of user's assigned role.	id (integer)
get_user_connections	Returns data about all connections for the authorized user.	No parameters
get_user_settings	Lists the settings of an authorized user. Example response contains a shortened list of settings.	No parameters
get_webhooks	Returns data about all the Webhooks of a company.	No parameters
post_webhooks	Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - event_action and event_object. E.g., use . for getting notifications about all events, create.deal for any newly added deals, delete.persons for any deleted persons, etc. See a href='https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference' target='_blank' rel='noopener noreferrer'the guide for Webhooks/a for more details.	data: { . subscription_url (string) . event_action (string) . event_object (string) . name (string) . user_id (integer) . http_auth_user (string) . http_auth_password (string) . version (string) } (object) required
delete_webhooks_by_id	Deletes the specified Webhook.	id (integer)
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)