KosmoKrator

productivity

Pipedrive MCP, CLI, and Lua Integration for AI Agents

Pipedrive integration docs for AI agents: MCP gateway setup, Pipedrive CLI commands, Lua API reference, credentials, and function schemas.

Pipedrive for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

Pipedrive CLIHeadless setup, JSON output, direct function calls. Pipedrive MCPExpose selected tools to local MCP clients. Pipedrive LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug
pipedrive
route_slug
pipedrive
package
pipedrive
auth_strategy
api_token
cli_setup_supported
true
cli_runtime_supported
true
mcp_gateway_supported
true
lua_supported
true

Function Catalog

FunctionTypeParametersDescription
pipedrive.pipedrive_add_activity_type Write write 0 Add new activity type Adds a new activity type.
pipedrive.pipedrive_add_call_log Write write 0 Add a call log Adds a new call log.
pipedrive.pipedrive_add_call_log_audio_file Write write 0 Attach an audio file to the call log Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.
pipedrive.pipedrive_add_channel Write write 0 Add a channel 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 extension](https://pipedrive.readme.io/docs/messaging-app-extension).
pipedrive.pipedrive_add_deal_field Write write 0 Add a new deal field 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>.
pipedrive.pipedrive_add_deal_follower Write write 0 Add a follower to a deal Adds a follower to a deal.
pipedrive.pipedrive_add_deal_participant Write write 0 Add a participant to a deal Adds a participant to a deal.
pipedrive.pipedrive_add_file Write write 0 Add file 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>.
pipedrive.pipedrive_add_file_and_link_it Write write 0 Create a remote file and link it to an item 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>.
pipedrive.pipedrive_add_filter Write write 0 Add a new filter 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="noopener noreferrer">adding a filter</a>.
pipedrive.pipedrive_add_goal Write write 0 Add a new goal Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
pipedrive.pipedrive_add_lead Write write 0 Add a lead 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 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. See an example given in the <a href="https://pipedrive.readme.io/docs/updating-custom-field-value" target="_blank" rel="noopener noreferrer">updating custom fields' values tutorial</a>.
pipedrive.pipedrive_add_lead_label Write write 0 Add a lead label Creates a lead label.
pipedrive.pipedrive_add_note_comment Write write 0 Add a comment to a note Adds a new comment to a note.
pipedrive.pipedrive_add_or_update_role_setting Write write 0 Add or update role setting Adds or updates the visibility setting for a role.
pipedrive.pipedrive_add_organization_field Write write 0 Add a new organization field 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>.
pipedrive.pipedrive_add_organization_follower Write write 0 Add a follower to an organization Adds a follower to an organization.
pipedrive.pipedrive_add_organization_relationship Write write 0 Create an organization relationship Creates and returns an organization relationship.
pipedrive.pipedrive_add_person_field Write write 0 Add a new person field 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>.
pipedrive.pipedrive_add_person_follower Write write 0 Add a follower to a person Adds a follower to a person.
pipedrive.pipedrive_add_person_picture Write write 0 Add person 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.
pipedrive.pipedrive_add_product_field Write write 0 Add a new product field 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>.
pipedrive.pipedrive_add_product_follower Write write 0 Add a follower to a product Adds a follower to a product.
pipedrive.pipedrive_add_project Write write 0 Add a project 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.
pipedrive.pipedrive_add_role Write write 0 Add a role Adds a new role.
pipedrive.pipedrive_add_role_assignment Write write 0 Add role assignment Assigns a user to a role.
pipedrive.pipedrive_add_task Write write 0 Add a task Adds a new task.
pipedrive.pipedrive_add_team Write write 0 Add a new team Adds a new team to the company and returns the created object.
pipedrive.pipedrive_add_team_user Write write 0 Add users to a team Adds users to an existing team.
pipedrive.pipedrive_add_user Write write 0 Add a new user Adds a new user to the company, returns the ID upon success.
pipedrive.pipedrive_add_webhook Write write 0 Create a new Webhook 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.
pipedrive.pipedrive_archive_project Write write 0 Archive a project Archives a project.
pipedrive.pipedrive_authorize Read read 0 Requesting authorization 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.
pipedrive.pipedrive_create_deal Write write 0 Add a new deal Adds a new deal.
pipedrive.pipedrive_create_note Write write 0 Add a note Adds a new note.
pipedrive.pipedrive_create_organization Write write 0 Add a new organization Adds a new organization.
pipedrive.pipedrive_create_person Write write 0 Add a new person Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
pipedrive.pipedrive_delete_activity_type Write write 0 Delete an activity type Marks an activity type as deleted.
pipedrive.pipedrive_delete_call_log Write write 0 Delete a call log 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.
pipedrive.pipedrive_delete_channel Write write 0 Delete a channel 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 extension](https://pipedrive.readme.io/docs/messaging-app-extension).
pipedrive.pipedrive_delete_comment Write write 0 Delete a comment related to a note Deletes a comment.
pipedrive.pipedrive_delete_conversation Write write 0 Delete a conversation 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 extension](https://pipedrive.readme.io/docs/messaging-app-extension).
pipedrive.pipedrive_delete_deal_field Write write 0 Delete a deal field 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>.
pipedrive.pipedrive_delete_deal_fields Write write 0 Delete multiple deal fields in bulk Marks multiple deal fields as deleted.
pipedrive.pipedrive_delete_deal_follower Write write 0 Delete a follower from a deal Deletes a follower from a deal.
pipedrive.pipedrive_delete_deal_participant Write write 0 Delete a participant from a deal Deletes a participant from a deal.
pipedrive.pipedrive_delete_file Write write 0 Delete a file Marks a file as deleted. After 30 days, the file will be permanently deleted.
pipedrive.pipedrive_delete_filter Write write 0 Delete a filter Marks a filter as deleted.
pipedrive.pipedrive_delete_filters Write write 0 Delete multiple filters in bulk Marks multiple filters as deleted.
pipedrive.pipedrive_delete_goal Write write 0 Delete existing goal Marks a goal as deleted.
pipedrive.pipedrive_delete_lead Write write 0 Delete a lead Deletes a specific lead.
pipedrive.pipedrive_delete_lead_label Write write 0 Delete a lead label Deletes a specific lead label.
pipedrive.pipedrive_delete_mail_thread Write write 0 Delete mail thread Marks a mail thread as deleted.
pipedrive.pipedrive_delete_note Write write 0 Delete a note Deletes a specific note.
pipedrive.pipedrive_delete_organization_field Write write 0 Delete an organization field 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>.
pipedrive.pipedrive_delete_organization_fields Write write 0 Delete multiple organization fields in bulk Marks multiple fields as deleted.
pipedrive.pipedrive_delete_organization_follower Write write 0 Delete a follower from an organization 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.
pipedrive.pipedrive_delete_organization_relationship Write write 0 Delete an organization relationship Deletes an organization relationship and returns the deleted ID.
pipedrive.pipedrive_delete_person_field Write write 0 Delete a person field 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>.
pipedrive.pipedrive_delete_person_fields Write write 0 Delete multiple person fields in bulk Marks multiple fields as deleted.
pipedrive.pipedrive_delete_person_follower Write write 0 Delete a follower from a person Deletes a follower from a person.
pipedrive.pipedrive_delete_person_picture Write write 0 Delete person picture Deletes a person's picture.
pipedrive.pipedrive_delete_product_field Write write 0 Delete a product field 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>.
pipedrive.pipedrive_delete_product_fields Write write 0 Delete multiple product fields in bulk Marks multiple fields as deleted.
pipedrive.pipedrive_delete_product_follower Write write 0 Delete a follower from a product Deletes a follower from a product.
pipedrive.pipedrive_delete_project Write write 0 Delete a project Marks a project as deleted.
pipedrive.pipedrive_delete_role Write write 0 Delete a role Marks a role as deleted.
pipedrive.pipedrive_delete_role_assignment Write write 0 Delete a role assignment Removes the assigned user from a role and adds to the default role.
pipedrive.pipedrive_delete_task Write write 0 Delete a task Marks a task as deleted. If the task has subtasks then those will also be deleted.
pipedrive.pipedrive_delete_team_user Write write 0 Delete users from a team Deletes users from an existing team.
pipedrive.pipedrive_delete_user_provider_link Write write 0 Delete the link between a user and the installed video call integration A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
pipedrive.pipedrive_delete_webhook Write write 0 Delete existing Webhook Deletes the specified Webhook.
pipedrive.pipedrive_download_file Read read 0 Download one file Initializes a file download.
pipedrive.pipedrive_duplicate_deal Write write 0 Duplicate deal Duplicates a deal.
pipedrive.pipedrive_find_users_by_name Read read 0 Find users by name Finds users by their name.
pipedrive.pipedrive_get_activity_fields Read read 0 Get all activity fields Returns all activity fields.
pipedrive.pipedrive_get_activity_types Read read 0 Get all activity types Returns all activity types.
pipedrive.pipedrive_get_archived_deals Read read 0 Get all archived deals Returns all archived deals.
pipedrive.pipedrive_get_archived_deals_summary Read read 0 Get archived deals summary Returns a summary of all archived deals.
pipedrive.pipedrive_get_archived_deals_timeline Read read 0 Get archived deals timeline 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`.
pipedrive.pipedrive_get_archived_leads Read read 0 Get all archived leads 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 fields' structure from deals.
pipedrive.pipedrive_get_call_log Read read 0 Get details of a call log Returns details of a specific call log.
pipedrive.pipedrive_get_comment Read read 0 Get one comment Returns the details of a comment.
pipedrive.pipedrive_get_company_addons Read read 0 Get all add-ons for a single company Returns the add-ons for a single company.
pipedrive.pipedrive_get_currencies Read read 0 Get all supported 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.
pipedrive.pipedrive_get_current_user Read read 0 Get current user data 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.
pipedrive.pipedrive_get_deal Read read 0 Get details of a deal Returns the details of a specific deal.
pipedrive.pipedrive_get_deal_changelog Read read 0 List updates about deal field values Lists updates about field values of a deal.
pipedrive.pipedrive_get_deal_field Read read 0 Get one deal field Returns data about a specific deal field.
pipedrive.pipedrive_get_deal_fields Read read 0 Get all deal fields Returns data about all deal fields.
pipedrive.pipedrive_get_deal_files Read read 0 List files attached to a deal Lists files associated with a deal.
pipedrive.pipedrive_get_deal_followers Read read 0 List followers of a deal Lists the followers of a deal.
pipedrive.pipedrive_get_deal_mail_messages Read read 0 List mail messages associated with a deal Lists mail messages associated with a deal.
pipedrive.pipedrive_get_deal_participants Read read 0 List participants of a deal Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
pipedrive.pipedrive_get_deal_participants_changelog Read read 0 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>.
pipedrive.pipedrive_get_deal_updates Read read 0 List updates about a deal Lists updates about a deal.
pipedrive.pipedrive_get_deal_users Read read 0 List permitted users Lists the users permitted to access a deal.
pipedrive.pipedrive_get_deals_summary Read read 0 Get deals summary Returns a summary of all not archived deals.
pipedrive.pipedrive_get_deals_timeline Read read 0 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`.
pipedrive.pipedrive_get_file Read read 0 Get one file Returns data about a specific file.
pipedrive.pipedrive_get_files Read read 0 Get all files Returns data about all files.
pipedrive.pipedrive_get_filter Read read 0 Get one filter Returns data about a specific filter. Note that this also returns the condition lines of the filter.
pipedrive.pipedrive_get_filter_helpers Read read 0 Get all filter 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>.
pipedrive.pipedrive_get_filters Read read 0 Get all filters Returns data about all filters.
pipedrive.pipedrive_get_goal_result Read read 0 Get result of a goal Gets the progress of a goal for the specified period.
pipedrive.pipedrive_get_goals Read read 0 Find goals 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.
pipedrive.pipedrive_get_lead Read read 0 Get one lead 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.
pipedrive.pipedrive_get_lead_fields Read read 0 Get all lead fields Returns data about all lead fields.
pipedrive.pipedrive_get_lead_labels Read read 0 Get all lead labels Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
pipedrive.pipedrive_get_lead_sources Read read 0 Get all 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.
pipedrive.pipedrive_get_lead_users Read read 0 List permitted users Lists the users permitted to access a lead.
pipedrive.pipedrive_get_leads Read read 0 Get all 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 fields' structure from deals.
pipedrive.pipedrive_get_mail_message Read read 0 Get one mail message Returns data about a specific mail message.
pipedrive.pipedrive_get_mail_thread Read read 0 Get one mail thread Returns a specific mail thread.
pipedrive.pipedrive_get_mail_thread_messages Read read 0 Get all mail messages of mail thread Returns all the mail messages inside a specified mail thread.
pipedrive.pipedrive_get_mail_threads Read read 0 Get mail threads Returns mail threads in a specified folder ordered by the most recent message within.
pipedrive.pipedrive_get_note Read read 0 Get one note Returns details about a specific note.
pipedrive.pipedrive_get_note_comments Read read 0 Get all comments for a note Returns all comments associated with a note.
pipedrive.pipedrive_get_note_fields Read read 0 Get all note fields Returns data about all note fields.
pipedrive.pipedrive_get_notes Read read 0 Get all notes Returns all notes.
pipedrive.pipedrive_get_organization Read read 0 Get details of a organization Returns the details of a specific organization.
pipedrive.pipedrive_get_organization_changelog Read read 0 List updates about organization field values Lists updates about field values of an organization.
pipedrive.pipedrive_get_organization_field Read read 0 Get one organization field Returns data about a specific organization field.
pipedrive.pipedrive_get_organization_fields Read read 0 Get all organization fields Returns data about all organization fields.
pipedrive.pipedrive_get_organization_files Read read 0 List files attached to an organization Lists files associated with an organization.
pipedrive.pipedrive_get_organization_followers Read read 0 List followers of an organization Lists the followers of an organization.
pipedrive.pipedrive_get_organization_mail_messages Read read 0 List mail messages associated with an organization Lists mail messages associated with an organization.
pipedrive.pipedrive_get_organization_relationship Read read 0 Get one organization relationship Finds and returns an organization relationship from its ID.
pipedrive.pipedrive_get_organization_relationships Read read 0 Get all relationships for organization Gets all of the relationships for a supplied organization ID.
pipedrive.pipedrive_get_organization_updates Read read 0 List updates about an organization Lists updates about an organization.
pipedrive.pipedrive_get_organization_users Read read 0 List permitted users List users permitted to access an organization.
pipedrive.pipedrive_get_permission_set Read read 0 Get one permission set Returns data about a specific permission set.
pipedrive.pipedrive_get_permission_set_assignments Read read 0 List permission set assignments Returns the list of assignments for a permission set.
pipedrive.pipedrive_get_permission_sets Read read 0 Get all permission sets Returns data about all permission sets.
pipedrive.pipedrive_get_person Read read 0 Get details of a person 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.
pipedrive.pipedrive_get_person_changelog Read read 0 List updates about person field values Lists updates about field values of a person.
pipedrive.pipedrive_get_person_field Read read 0 Get one person field Returns data about a specific person field.
pipedrive.pipedrive_get_person_fields Read read 0 Get all person fields Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
pipedrive.pipedrive_get_person_files Read read 0 List files attached to a person Lists files associated with a person.
pipedrive.pipedrive_get_person_followers Read read 0 List followers of a person Lists the followers of a person.
pipedrive.pipedrive_get_person_mail_messages Read read 0 List mail messages associated with a person Lists mail messages associated with a person.
pipedrive.pipedrive_get_person_products Read read 0 List products associated with a person Lists products associated with a person.
pipedrive.pipedrive_get_person_updates Read read 0 List updates about a person Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.
pipedrive.pipedrive_get_person_users Read read 0 List permitted users List users permitted to access a person.
pipedrive.pipedrive_get_pipeline_conversion_statistics Read read 0 Get deals conversion rates in pipeline Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
pipedrive.pipedrive_get_pipeline_deals Read read 0 Get deals in a pipeline 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. <br>This 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.
pipedrive.pipedrive_get_pipeline_movement_statistics Read read 0 Get deals movements in pipeline Returns statistics for deals movements for the given time period.
pipedrive.pipedrive_get_product_deals Read read 0 Get deals where a product is attached to Returns data about deals that have a product attached to it.
pipedrive.pipedrive_get_product_field Read read 0 Get one product field Returns data about a specific product field.
pipedrive.pipedrive_get_product_fields Read read 0 Get all product fields Returns data about all product fields.
pipedrive.pipedrive_get_product_files Read read 0 List files attached to a product Lists files associated with a product.
pipedrive.pipedrive_get_product_followers Read read 0 List followers of a product Lists the followers of a product.
pipedrive.pipedrive_get_product_users Read read 0 List permitted users Lists users permitted to access a product.
pipedrive.pipedrive_get_project Read read 0 Get details of a project 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.
pipedrive.pipedrive_get_project_activities Read read 0 Returns project activities Returns activities linked to a specific project.
pipedrive.pipedrive_get_project_groups Read read 0 Returns project groups Returns all active groups under a specific project.
pipedrive.pipedrive_get_project_plan Read read 0 Returns project plan Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.
pipedrive.pipedrive_get_project_tasks Read read 0 Returns project tasks Returns tasks linked to a specific project.
pipedrive.pipedrive_get_project_template Read read 0 Get details of a template Returns the details of a specific project template.
pipedrive.pipedrive_get_project_templates Read read 0 Get all 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>.
pipedrive.pipedrive_get_projects Read read 0 Get all 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>.
pipedrive.pipedrive_get_projects_board Read read 0 Get details of a board Returns the details of a specific project board.
pipedrive.pipedrive_get_projects_boards Read read 0 Get all project boards Returns all projects boards that are not deleted.
pipedrive.pipedrive_get_projects_phase Read read 0 Get details of a phase Returns the details of a specific project phase.
pipedrive.pipedrive_get_projects_phases Read read 0 Get project phases Returns all active project phases under a specific board.
pipedrive.pipedrive_get_recents Read read 0 Get recents Returns data about all recent changes occurred after the given timestamp.
pipedrive.pipedrive_get_role Read read 0 Get one role Returns the details of a specific role.
pipedrive.pipedrive_get_role_assignments Read read 0 List role assignments Returns all users assigned to a role.
pipedrive.pipedrive_get_role_pipelines Read read 0 List pipeline visibility for a role 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>.
pipedrive.pipedrive_get_role_settings Read read 0 List role settings Returns the visibility settings of a specific role.
pipedrive.pipedrive_get_roles Read read 0 Get all roles Returns all the roles within the company.
pipedrive.pipedrive_get_stage_deals Read read 0 Get deals in a stage Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. <br>This 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.
pipedrive.pipedrive_get_task Read read 0 Get details of a task Returns the details of a specific task.
pipedrive.pipedrive_get_tasks Read read 0 Get all 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>.
pipedrive.pipedrive_get_team Read read 0 Get a single team Returns data about a specific team.
pipedrive.pipedrive_get_team_users Read read 0 Get all users in a team Returns a list of all user IDs within a team.
pipedrive.pipedrive_get_teams Read read 0 Get all teams Returns data about teams within the company.
pipedrive.pipedrive_get_tokens Write write 0 Getting the tokens 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.
pipedrive.pipedrive_get_user Read read 0 Get one user Returns data about a specific user within the company.
pipedrive.pipedrive_get_user_call_logs Read read 0 Get all call logs assigned to a particular user Returns all call logs assigned to a particular user.
pipedrive.pipedrive_get_user_connections Read read 0 Get all user connections Returns data about all connections for the authorized user.
pipedrive.pipedrive_get_user_followers Read read 0 List followers of a user Lists the followers of a specific user.
pipedrive.pipedrive_get_user_permissions Read read 0 List user permissions Lists aggregated permissions over all assigned permission sets for a user.
pipedrive.pipedrive_get_user_role_assignments Read read 0 List role assignments Lists role assignments for a user.
pipedrive.pipedrive_get_user_role_settings Read read 0 List user role settings Lists the settings of user's assigned role.
pipedrive.pipedrive_get_user_settings Read read 0 List settings of an authorized user Lists the settings of an authorized user. Example response contains a shortened list of settings.
pipedrive.pipedrive_get_user_teams Read read 0 Get all teams of a user Returns data about all teams which have the specified user as a member.
pipedrive.pipedrive_get_users Read read 0 Get all users Returns data about all users within the company.
pipedrive.pipedrive_get_webhooks Read read 0 Get all Webhooks Returns data about all the Webhooks of a company.
pipedrive.pipedrive_link_file_to_item Write write 0 Link a remote file to an item 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>.
pipedrive.pipedrive_list_deals Read read 0 Get all deals Returns data about all not archived deals.
pipedrive.pipedrive_list_organizations Read read 0 Get all organizations Returns data about all organizations.
pipedrive.pipedrive_list_persons Read read 0 Get all 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.
pipedrive.pipedrive_list_pipelines Read read 0 Get all pipelines Returns data about all pipelines.
pipedrive.pipedrive_list_stages Read read 0 Get all stages Returns data about all stages.
pipedrive.pipedrive_merge_deals Write write 0 Merge two deals 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>.
pipedrive.pipedrive_merge_organizations Write write 0 Merge two organizations 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>.
pipedrive.pipedrive_merge_persons Write write 0 Merge two persons 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>.
pipedrive.pipedrive_put_project_plan_activity Write write 0 Update activity in project plan Updates an activity phase or group in a project.
pipedrive.pipedrive_put_project_plan_task Write write 0 Update task in project plan Updates a task phase or group in a project.
pipedrive.pipedrive_receive_message Write write 0 Receives an incoming message 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 extension](https://pipedrive.readme.io/docs/messaging-app-extension).
pipedrive.pipedrive_refresh_tokens Write write 0 Refreshing the tokens The `access_token` has a lifetime. After a period of time, which was returned to you in `expires_in` JSON property, the `access_token` will be invalid, and you can no longer use it to get data from our API. To refresh the `access_token`, you must use the `refresh_token`.
pipedrive.pipedrive_save_user_provider_link Write write 0 Link a user with the installed video call integration 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.
pipedrive.pipedrive_search_leads Read read 0 Search leads 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.
pipedrive.pipedrive_search_organizations Read read 0 Search organizations 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.
pipedrive.pipedrive_search_persons Read read 0 Search persons 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.
pipedrive.pipedrive_update_activity_type Write write 0 Update an activity type Updates an activity type.
pipedrive.pipedrive_update_comment_for_note Write write 0 Update a comment related to a note Updates a comment related to a note.
pipedrive.pipedrive_update_deal Write write 0 Update a deal Updates the properties of a deal.
pipedrive.pipedrive_update_deal_field Write write 0 Update a deal field 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>.
pipedrive.pipedrive_update_file Write write 0 Update file details Updates the properties of a file.
pipedrive.pipedrive_update_filter Write write 0 Update filter Updates an existing filter.
pipedrive.pipedrive_update_goal Write write 0 Update existing goal Updates an existing goal.
pipedrive.pipedrive_update_lead Write write 0 Update a lead 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 inherit the custom fields' structure from deals. See an example given in the <a href="https://pipedrive.readme.io/docs/updating-custom-field-value" target="_blank" rel="noopener noreferrer">updating custom fields' values tutorial</a>.
pipedrive.pipedrive_update_lead_label Write write 0 Update a lead label Updates one or more properties of a lead label. Only properties included in the request will be updated.
pipedrive.pipedrive_update_mail_thread_details Write write 0 Update mail thread details Updates the properties of a mail thread.
pipedrive.pipedrive_update_note Write write 0 Update a note Updates a note.
pipedrive.pipedrive_update_organization Write write 0 Update a organization Updates the properties of a organization.
pipedrive.pipedrive_update_organization_field Write write 0 Update an organization field 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>.
pipedrive.pipedrive_update_organization_relationship Write write 0 Update an organization relationship Updates and returns an organization relationship.
pipedrive.pipedrive_update_person Write write 0 Update a person Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
pipedrive.pipedrive_update_person_field Write write 0 Update a person field 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>.
pipedrive.pipedrive_update_product_field Write write 0 Update a product field 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>.
pipedrive.pipedrive_update_project Write write 0 Update a project Updates a project.
pipedrive.pipedrive_update_role Write write 0 Update role details Updates the parent role and/or the name of a specific role.
pipedrive.pipedrive_update_role_pipelines Write write 0 Update pipeline visibility for a role 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>.
pipedrive.pipedrive_update_task Write write 0 Update a task Updates a task.
pipedrive.pipedrive_update_team Write write 0 Update a team Updates an existing team and returns the updated object.
pipedrive.pipedrive_update_user Write write 0 Update user details Updates the properties of a user. Currently, only `active_flag` can be updated.
pipedrive.pipedrive_v2_add_activity Write write 0 Add a new activity Adds a new activity.
pipedrive.pipedrive_v2_add_deal_field Write write 0 Create one deal field Creates a new deal custom field.
pipedrive.pipedrive_v2_add_deal_field_options Write write 0 Add deal field options in bulk Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
pipedrive.pipedrive_v2_add_deal_follower Write write 0 Add a follower to a deal Adds a user as a follower to the deal.
pipedrive.pipedrive_v2_add_deal_product Write write 0 Add a product to a deal Adds a product to a deal, creating a new item called a deal-product.
pipedrive.pipedrive_v2_add_many_deal_products Write write 0 Add multiple products to a deal Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
pipedrive.pipedrive_v2_add_organization_field Write write 0 Create one organization field Creates a new organization custom field.
pipedrive.pipedrive_v2_add_organization_field_options Write write 0 Add organization field options in bulk Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
pipedrive.pipedrive_v2_add_organization_follower Write write 0 Add a follower to an organization Adds a user as a follower to the organization.
pipedrive.pipedrive_v2_add_person_field Write write 0 Create one person field Creates a new person custom field.
pipedrive.pipedrive_v2_add_person_field_options Write write 0 Add person field options in bulk Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
pipedrive.pipedrive_v2_add_person_follower Write write 0 Add a follower to a person Adds a user as a follower to the person.
pipedrive.pipedrive_v2_add_pipeline Write write 0 Add a new pipeline Adds a new pipeline.
pipedrive.pipedrive_v2_add_product Write write 0 Add a product 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>.
pipedrive.pipedrive_v2_add_product_field Write write 0 Create one product field Creates a new product custom field.
pipedrive.pipedrive_v2_add_product_field_options Write write 0 Add product field options in bulk Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
pipedrive.pipedrive_v2_add_product_follower Write write 0 Add a follower to a product Adds a user as a follower to the product.
pipedrive.pipedrive_v2_add_product_variation Write write 0 Add a product variation Adds a new product variation.
pipedrive.pipedrive_v2_add_project Write write 0 Add a project Adds a new project. Custom fields should be wrapped in the `custom_fields` object.
pipedrive.pipedrive_v2_add_project_board Write write 0 Add a project board Adds a new project board.
pipedrive.pipedrive_v2_add_project_field Write write 0 Create one project field Creates a new project custom field.
pipedrive.pipedrive_v2_add_project_field_options Write write 0 Add project field options in bulk Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
pipedrive.pipedrive_v2_add_project_phase Write write 0 Add a project phase Adds a new project phase to a board.
pipedrive.pipedrive_v2_add_stage Write write 0 Add a new stage Adds a new stage, returns the ID upon success.
pipedrive.pipedrive_v2_add_task Write write 0 Add a task Adds a new task.
pipedrive.pipedrive_v2_archive_project Write write 0 Archive a project Archives a project.
pipedrive.pipedrive_v2_convert_deal_to_lead Write write 0 Convert a deal to a 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 <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
pipedrive.pipedrive_v2_convert_lead_to_deal Write write 0 Convert a lead to a 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/{conversion_id}</a> endpoint.
pipedrive.pipedrive_v2_delete_activity Write write 0 Delete an activity Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
pipedrive.pipedrive_v2_delete_additional_discount Write write 0 Delete a discount from a deal Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
pipedrive.pipedrive_v2_delete_deal Write write 0 Delete a deal Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
pipedrive.pipedrive_v2_delete_deal_field Write write 0 Delete one deal field Marks a custom field as deleted.
pipedrive.pipedrive_v2_delete_deal_field_options Write write 0 Delete deal field options in bulk Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
pipedrive.pipedrive_v2_delete_deal_follower Write write 0 Delete a follower from a deal Deletes a user follower from the deal.
pipedrive.pipedrive_v2_delete_deal_product Write write 0 Delete an attached product from a deal Deletes a product attachment from a deal, using the `product_attachment_id`.
pipedrive.pipedrive_v2_delete_installment Write write 0 Delete an installment from a deal Removes an installment from a deal. Only available in Growth and above plans.
pipedrive.pipedrive_v2_delete_many_deal_products Write write 0 Delete many products from a deal 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.
pipedrive.pipedrive_v2_delete_organization Write write 0 Delete a organization Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
pipedrive.pipedrive_v2_delete_organization_field Write write 0 Delete one organization field Marks a custom field as deleted.
pipedrive.pipedrive_v2_delete_organization_field_options Write write 0 Delete organization field options in bulk Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
pipedrive.pipedrive_v2_delete_organization_follower Write write 0 Delete a follower from an organization Deletes a user follower from the organization.
pipedrive.pipedrive_v2_delete_person Write write 0 Delete a person Marks a person as deleted. After 30 days, the person will be permanently deleted.
pipedrive.pipedrive_v2_delete_person_field Write write 0 Delete one person field Marks a custom field as deleted.
pipedrive.pipedrive_v2_delete_person_field_options Write write 0 Delete person field options in bulk Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
pipedrive.pipedrive_v2_delete_person_follower Write write 0 Delete a follower from a person Deletes a user follower from the person.
pipedrive.pipedrive_v2_delete_pipeline Write write 0 Delete a pipeline Marks a pipeline as deleted.
pipedrive.pipedrive_v2_delete_product Write write 0 Delete a product Marks a product as deleted. After 30 days, the product will be permanently deleted.
pipedrive.pipedrive_v2_delete_product_field Write write 0 Delete one product field Marks a custom field as deleted.
pipedrive.pipedrive_v2_delete_product_field_options Write write 0 Delete product field options in bulk Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
pipedrive.pipedrive_v2_delete_product_follower Write write 0 Delete a follower from a product Deletes a user follower from the product.
pipedrive.pipedrive_v2_delete_product_image Write write 0 Delete an image of a product Deletes the image of a product.
pipedrive.pipedrive_v2_delete_product_variation Write write 0 Delete a product variation Deletes a product variation.
pipedrive.pipedrive_v2_delete_project Write write 0 Delete a project Marks a project as deleted.
pipedrive.pipedrive_v2_delete_project_board Write write 0 Delete a project board Marks a project board as deleted.
pipedrive.pipedrive_v2_delete_project_field Write write 0 Delete one project field Marks a custom field as deleted.
pipedrive.pipedrive_v2_delete_project_field_options Write write 0 Delete project field options in bulk Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
pipedrive.pipedrive_v2_delete_project_phase Write write 0 Delete a project phase Marks a project phase as deleted.
pipedrive.pipedrive_v2_delete_stage Write write 0 Delete a stage Marks a stage as deleted.
pipedrive.pipedrive_v2_delete_task Write write 0 Delete a task Marks a task as deleted. If the task has subtasks, those will also be deleted.
pipedrive.pipedrive_v2_duplicate_product Write write 0 Duplicate a product Creates a duplicate of an existing product including all variations, prices, and custom fields.
pipedrive.pipedrive_v2_get_activities Read read 0 Get all activities Returns data about all activities.
pipedrive.pipedrive_v2_get_activity Read read 0 Get details of an activity Returns the details of a specific activity.
pipedrive.pipedrive_v2_get_activity_field Read read 0 Get one activity field Returns metadata about a specific activity field.
pipedrive.pipedrive_v2_get_activity_fields Read read 0 Get all activity fields Returns metadata about all activity fields in the company.
pipedrive.pipedrive_v2_get_additional_discounts Read read 0 List discounts added to a deal Lists discounts attached to a deal.
pipedrive.pipedrive_v2_get_archived_deals Read read 0 Get all archived deals Returns data about all archived deals.
pipedrive.pipedrive_v2_get_archived_projects Read read 0 Get all archived projects Returns all archived projects.
pipedrive.pipedrive_v2_get_deal_conversion_status Read read 0 Get Deal conversion status 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.
pipedrive.pipedrive_v2_get_deal_field Read read 0 Get one deal field Returns metadata about a specific deal field.
pipedrive.pipedrive_v2_get_deal_fields Read read 0 Get all deal fields Returns metadata about all deal fields in the company.
pipedrive.pipedrive_v2_get_deal_followers Read read 0 List followers of a deal Lists users who are following the deal.
pipedrive.pipedrive_v2_get_deal_followers_changelog Read read 0 List followers changelog of a deal Lists changelogs about users have followed the deal.
pipedrive.pipedrive_v2_get_deal_products Read read 0 List products attached to a deal Lists products attached to a deal.
pipedrive.pipedrive_v2_get_deals_products Read read 0 Get deal products of several deals Returns data about products attached to deals
pipedrive.pipedrive_v2_get_installments Read read 0 List installments added to a list of deals Lists installments attached to a list of deals. Only available in Growth and above plans.
pipedrive.pipedrive_v2_get_lead_conversion_status Read read 0 Get Lead conversion status 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.
pipedrive.pipedrive_v2_get_organization_field Read read 0 Get one organization field Returns metadata about a specific organization field.
pipedrive.pipedrive_v2_get_organization_fields Read read 0 Get all organization fields Returns metadata about all organization fields in the company.
pipedrive.pipedrive_v2_get_organization_followers Read read 0 List followers of an organization Lists users who are following the organization.
pipedrive.pipedrive_v2_get_organization_followers_changelog Read read 0 List followers changelog of an organization Lists changelogs about users have followed the organization.
pipedrive.pipedrive_v2_get_person_field Read read 0 Get one person field Returns metadata about a specific person field.
pipedrive.pipedrive_v2_get_person_fields Read read 0 Get all person fields Returns metadata about all person fields in the company.
pipedrive.pipedrive_v2_get_person_followers Read read 0 List followers of a person Lists users who are following the person.
pipedrive.pipedrive_v2_get_person_followers_changelog Read read 0 List followers changelog of a person Lists changelogs about users have followed the person.
pipedrive.pipedrive_v2_get_person_picture Read read 0 Get picture of a person Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
pipedrive.pipedrive_v2_get_pipeline Read read 0 Get one pipeline Returns data about a specific pipeline.
pipedrive.pipedrive_v2_get_product Read read 0 Get one product Returns data about a specific product.
pipedrive.pipedrive_v2_get_product_field Read read 0 Get one product field Returns metadata about a specific product field.
pipedrive.pipedrive_v2_get_product_fields Read read 0 Get all product fields Returns metadata about all product fields in the company.
pipedrive.pipedrive_v2_get_product_followers Read read 0 List followers of a product Lists users who are following the product.
pipedrive.pipedrive_v2_get_product_followers_changelog Read read 0 List followers changelog of a product Lists changelogs about users have followed the product.
pipedrive.pipedrive_v2_get_product_image Read read 0 Get image of a product Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
pipedrive.pipedrive_v2_get_product_variations Read read 0 Get all product variations Returns data about all product variations.
pipedrive.pipedrive_v2_get_products Read read 0 Get all products Returns data about all products.
pipedrive.pipedrive_v2_get_project Read read 0 Get details of a project Returns the details of a specific project. Custom fields appear as keys inside the `custom_fields` object.
pipedrive.pipedrive_v2_get_project_changelog Read read 0 List updates about project field values Lists updates about field values of a project.
pipedrive.pipedrive_v2_get_project_field Read read 0 Get one project field Returns metadata about a specific project field.
pipedrive.pipedrive_v2_get_project_fields Read read 0 Get all project fields Returns metadata about all project fields in the company.
pipedrive.pipedrive_v2_get_project_template Read read 0 Get details of a template Returns the details of a specific project template.
pipedrive.pipedrive_v2_get_project_templates Read read 0 Get all project templates Returns all not deleted project templates.
pipedrive.pipedrive_v2_get_project_users Read read 0 List permitted users Lists the users permitted to access a project.
pipedrive.pipedrive_v2_get_projects Read read 0 Get all projects Returns all non-archived projects.
pipedrive.pipedrive_v2_get_projects_board Read read 0 Get details of a project board Returns the details of a specific project board.
pipedrive.pipedrive_v2_get_projects_boards Read read 0 Get all project boards Returns all active project boards.
pipedrive.pipedrive_v2_get_projects_phase Read read 0 Get details of a project phase Returns the details of a specific project phase.
pipedrive.pipedrive_v2_get_projects_phases Read read 0 Get project phases Returns all active project phases under a specific board.
pipedrive.pipedrive_v2_get_stage Read read 0 Get one stage Returns data about a specific stage.
pipedrive.pipedrive_v2_get_task Read read 0 Get details of a task Returns the details of a specific task.
pipedrive.pipedrive_v2_get_tasks Read read 0 Get all tasks Returns all tasks.
pipedrive.pipedrive_v2_get_user_followers Read read 0 List followers of a user Lists users who are following the user.
pipedrive.pipedrive_v2_post_additional_discount Write write 0 Add a discount to a deal Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
pipedrive.pipedrive_v2_post_installment Write write 0 Add an installment to a deal 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.
pipedrive.pipedrive_v2_search_deals Read read 0 Search deals 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.
pipedrive.pipedrive_v2_search_item Read read 0 Perform a search from multiple item types Performs a search from your choice of item types and fields.
pipedrive.pipedrive_v2_search_item_by_field Read read 0 Perform a search using a specific field from an item type 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).
pipedrive.pipedrive_v2_search_leads Read read 0 Search leads 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.
pipedrive.pipedrive_v2_search_products Read read 0 Search products 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.
pipedrive.pipedrive_v2_search_projects Read read 0 Search projects Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
pipedrive.pipedrive_v2_update_activity Write write 0 Update an activity Updates the properties of an activity.
pipedrive.pipedrive_v2_update_additional_discount Write write 0 Update a discount added to a deal Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
pipedrive.pipedrive_v2_update_deal_field Write write 0 Update one deal field Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
pipedrive.pipedrive_v2_update_deal_field_options Write write 0 Update deal field options in bulk Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
pipedrive.pipedrive_v2_update_deal_product Write write 0 Update the product attached to a deal Updates the details of the product that has been attached to a deal.
pipedrive.pipedrive_v2_update_installment Write write 0 Update an installment added to a deal Edits an installment added to a deal. Only available in Growth and above plans.
pipedrive.pipedrive_v2_update_organization_field Write write 0 Update one organization field Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
pipedrive.pipedrive_v2_update_organization_field_options Write write 0 Update organization field options in bulk Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
pipedrive.pipedrive_v2_update_person_field Write write 0 Update one person field Updates a person custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
pipedrive.pipedrive_v2_update_person_field_options Write write 0 Update person field options in bulk Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
pipedrive.pipedrive_v2_update_pipeline Write write 0 Update a pipeline Updates the properties of a pipeline.
pipedrive.pipedrive_v2_update_product Write write 0 Update a product Updates product data.
pipedrive.pipedrive_v2_update_product_field Write write 0 Update one product field Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
pipedrive.pipedrive_v2_update_product_field_options Write write 0 Update product field options in bulk Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
pipedrive.pipedrive_v2_update_product_image Write write 0 Update an image for a product Updates the image of a product.
pipedrive.pipedrive_v2_update_product_variation Write write 0 Update a product variation Updates product variation data.
pipedrive.pipedrive_v2_update_project Write write 0 Update a project Updates the properties of a project.
pipedrive.pipedrive_v2_update_project_board Write write 0 Update a project board Updates the properties of a project board.
pipedrive.pipedrive_v2_update_project_field Write write 0 Update one project field Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
pipedrive.pipedrive_v2_update_project_field_options Write write 0 Update project field options in bulk Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
pipedrive.pipedrive_v2_update_project_phase Write write 0 Update a project phase Updates the properties of a project phase.
pipedrive.pipedrive_v2_update_stage Write write 0 Update stage details Updates the properties of a stage.
pipedrive.pipedrive_v2_update_task Write write 0 Update a task Updates a task.
pipedrive.pipedrive_v2_upload_product_image Write write 0 Upload an image for a product Uploads an image for a product.