Pipedrive

Tool to attach an audio recording to an existing call log in Pipedrive. Use when you need to add audio evidence to a call log. Only one recording per call log is allowed.

Tool to add a note to a deal, person, organization, lead, or project in Pipedrive. Use when you need to create a note attached to an entity. At least one entity ID (lead_id, deal_id, person_id, org_id, or project_id) must be provided.

Tool to add new options to an organization field in Pipedrive. Use when you need to add new choices to enum or set type organization fields. This is an atomic operation where all options are added or none.

Tool to upload an image for a product in Pipedrive. Use when you need to add a visual representation to a product.

Tool to add a new product variation to an existing product. Use when you need to create product variations with different pricing across currencies. Each variation can have multiple prices in different currencies, but only one price per currency is supported.

Adds a new call log.

New messaging channel added; registration limited to admins. Utilizes getConversations endpoint for data retrieval. Requires Messengers integration OAuth scope and a prepared Messaging app extension manifest.

Add a new deal to Pipedrive with any custom fields, which vary by account and are identified by long hash keys. Check dealFields for existing custom fields. For details, visit the tutorial on adding a deal.

Adds a follower to a deal.

Tool to add a follower to a person in Pipedrive. Use when you need to create a follower relationship between a user and a person entity.

Pipedrive API lets you add leads linked to people or organizations and tags them with 'API' source. Custom fields from deals apply to leads and appear in responses if set. Details are in the tutorials for adding and updating leads.

Creates a lead label.

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>.

New filter creation returns an ID. Only one primary condition group with 'AND' and two secondary groups (one 'AND', one 'OR') are supported. Future syntax expansion possible. See tutorial for details.

Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.

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>.

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>.

Adds a new pipeline (v2).

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>.

Adds a new stage, returns the ID upon success.

Adds a new team to the company and returns the created object.

Adds a new user to the company, returns the ID upon success.

DEPRECATED: Use PIPEDRIVE_PIPEDRIVE_ADD_NOTE instead. Add a note to a deal, person, organization, lead, or project in Pipedrive. At least one of deal_id, person_id, org_id, lead_id, or project_id must be provided.

Adds a participant to a deal.

Add a new contact in Pipedrive with optional custom fields unique to each account found using the `personFields` endpoint. The endpoint also handles `data.marketing_status` for Campaigns product users.

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>.

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.

Adds a new recurring subscription.

Adds a new role. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used.

Adds a new task.

New activity added. Response includes `more_activities_scheduled_in_context` to show if more are planned with the same entity. See tutorial on adding activities [here](https://pipedrive.readme.io/docs/adding-an-activity).

Adds a new installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action overrides the default request behavior and uses the public API host (api.pipedrive.com) explicitly.

Creates a new organization in Pipedrive. The 'name' parameter is required and represents the organization's name (e.g., 'Acme Corp'). Optionally specify 'owner_id' to assign an owner and 'visible_to' for visibility settings. Custom fields can also be added using field keys from organizationFields.

Tool to add a comment to an existing note in Pipedrive. Use when you need to add commentary or updates to notes linked to deals, persons, or organizations.

Tool to add new options to a deal custom field atomically. Use when you need to add options to enum or set type deal fields.

Tool to add a discount to a deal in Pipedrive. Use when you need to apply a percentage-based or fixed amount discount to an existing deal.

Upload and link files to deals, people, organizations, activities, products, or leads in Pipedrive. See the "adding a file" tutorial for details.

Tool to add a follower to a product in Pipedrive. Use when you need to have a user follow a specific product for updates and notifications.

Adds a new activity type.

Adds or updates the visibility setting for a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the base URL accordingly.

Tool to add a follower to an organization in Pipedrive. Use when you need to create a follower relationship between a user and an organization entity.

Tool to bulk add options to enum/set person fields atomically. Use when you need to add new options to a person field.

This service allows adding a photo to a person's profile, replacing any existing one. Images must be square with a minimum size of 128 pixels and in GIF, JPG, or PNG formats. They will be resized to 128 and 512 pixels.

Tool to add new options to a product custom field that supports options (enum or set field types). Use when you need to expand the available choices for a product field. This operation is atomic - all options are added or none are added.

Tool to add a product to a deal in Pipedrive. Use when you need to attach a product to an existing deal with custom pricing, quantity, duration, discount, and tax settings.

Assigns a user to a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/assignments - This action normalizes the base URL accordingly and ensures JSON body is sent.

Adds users to an existing team.

Archives a project.

Tool to bulk add products to a Pipedrive deal. Use when attaching multiple products simultaneously, with maximum 100 products per request.

Cancels a recurring subscription. This action attempts to cancel a recurring subscription via Subscriptions API. If Subscriptions endpoints are unavailable (404), it gracefully falls back to disabling all product attachments on the given deal (interpreting `id` as `deal_id`) to mimic cancellation behavior.

Tool to convert a Pipedrive lead to a deal asynchronously. Use when you need to convert an existing lead into a deal. The conversion transfers all related entities (notes, files, emails, activities) to the new deal. Upon successful conversion, the lead is marked as deleted. Use the returned conversion_id to check the conversion status.

Tool to convert a Pipedrive deal to a lead asynchronously. Use when you need to move a deal back to the lead stage, transferring related entities like notes, files, emails, and activities. Requires global admin or 'Convert deals to leads' permission.

Creates and returns details of a new Webhook. Trigger events combine `event_action` and `event_object`, like `*.*` for all events or `added.deal`, `deleted.persons` for specific actions. More info in the Webhooks guide.

Creates an empty file on Google Drive linked to an item. For details, refer to the Pipedrive remote file adding tutorial.

Creates and returns an organization relationship.

Tool to create a new product variation for an existing product. Use when you need to add a variation with customizable name and prices in multiple currencies.

Tool to delete an activity in Pipedrive. Use when you need to remove an activity. This is a soft delete operation - the activity will be permanently deleted after 30 days.

Tool to delete an activity type in Pipedrive. Use when you need to remove an activity type from the system. The activity type will be marked as deleted (active_flag set to false) rather than permanently removed.

Tool to delete a deal in Pipedrive. Use when you need to remove a deal. This is a soft delete operation - the deal will be permanently deleted after 30 days.

Tool to delete a discount from a deal in Pipedrive. Use when you need to remove a discount that was previously applied to a deal.

Tool to delete an attached product from a deal in Pipedrive. Use when you need to remove a product that was previously attached to a deal. Note: It is not possible to delete the attached product if the deal has installments associated with it.

Tool to delete multiple products from a deal in Pipedrive. Use when you need to remove specific products or all products from a deal. Maximum 100 products can be deleted per request.

Tool to delete a filter in Pipedrive. Use when you need to remove a specific filter by its ID.

Tool to delete an image from a product in Pipedrive. Use when you need to remove a product image.

Tool to delete a product variation from a product in Pipedrive. Use when you need to remove a specific variation from a product.

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.

The endpoint removes a messenger channel along with conversations and messages. Requires Messengers integration OAuth and Messaging app extension manifest.

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).

Tool to delete a deal field in Pipedrive by marking it as deleted. Use when you need to remove a custom deal field.

Tool to delete a file in Pipedrive. Use when you need to remove a file from the system. The file is marked as deleted immediately but will be permanently deleted after 30 days.

Deletes a follower from a person.

Deletes a follower from a product.

Deletes a specific lead.

Deletes a specific note.

Deletes a participant from a deal.

Marks a person as deleted. After 30 days, the person will be permanently deleted.

Tool to delete a person in Pipedrive. Use when you need to mark a person as deleted. The person will be permanently deleted after 30 days.

Tool to delete a person field from Pipedrive. Use when you need to remove a custom person field by its unique identifier.

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>.

Marks a pipeline as deleted.

Marks a product as deleted. After 30 days, the product will be permanently deleted.

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>.

Marks a project as deleted.

Marks a role as deleted. Note: This endpoint requires admin permissions. The API token must have the 'admin' scope to delete roles. The default role (ID=1) cannot be deleted.

Removes the assigned user from a role and adds to the default role.

Marks a stage as deleted. Uses the company-domain v2 endpoint.

Tool to delete a stage in Pipedrive. Use when you need to mark a stage as deleted.

Marks an installment or a recurring subscription as deleted.

Marks a task as deleted. If the task has subtasks then those will also be deleted.

Marks an activity as deleted. After 30 days, the activity will be permanently deleted.

Tool to delete an organization in Pipedrive. Use when you need to mark an organization as deleted. The organization will be permanently deleted after 30 days.

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>.

Deletes an organization relationship and returns the deleted ID.

Tool to delete a comment from a note in Pipedrive. Use when you need to remove a specific comment that was previously added to a note. Users can only delete comments they created or if they have admin privileges.

Tool to remove existing options from a deal custom field atomically. Use when you need to delete options from a deal field.

Tool to delete a follower from a deal in Pipedrive. Use when you need to remove a user from a deal's follower list.

Marks a goal as deleted. Notes: - Pipedrive Goals endpoints for OAuth live under `{companydomain}/api/v1`. The default base_url is usually `{companydomain}/v1`, which would yield 404. We therefore normalize the base URL to `/api/v1` before issuing the DELETE.

Deletes the specified Webhook.

Tool to delete a specific lead label from Pipedrive. Use when you need to remove a lead label using its UUID identifier.

Marks a mail thread as deleted.

Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.

Marks multiple activity types as deleted.

Marks multiple deal fields as deleted.

Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.

Marks multiple filters as deleted.

Marks multiple fields as deleted.

Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.

Marks multiple fields as deleted.

Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.

Marks multiple fields as deleted.

Marks multiple stages as deleted (v1). Note: This endpoint may be deprecated; we keep compatibility and avoid raising to surface API errors in response.

Tool to delete specified options from an organization field in Pipedrive. Use when you need to remove one or more options from an organization field by field code. The operation is atomic: if any option ID does not exist, the entire request fails and no options are deleted.

Tool to delete a follower from an organization in Pipedrive. Use when you need to remove a user from an organization's follower list.

Tool to remove existing options from a person custom field atomically. Use when you need to delete options from a person field.

Deletes a person’s picture. Note: Pipedrive may return a 400 with error "Item not found" when the person has no picture set. Since delete is idempotent, we treat this specific case as a successful no-op and return a normalized response rather than raising.

Tool to remove existing options from a product custom field atomically. Use when you need to delete options from a product field.

Deletes users from an existing team.

Initializes a file download.

Tool to duplicate a specific product in Pipedrive. Use when you need to create a copy of an existing product with all its properties and pricing information.

Duplicates a deal.

Lists the users permitted to access a lead.

Query goal data by appending `{searchField}={searchValue}` to the URL with dot-notation fields and values. Include `is_active` to filter by goal status and specify both `period.start` and `period.end` for time-based searches.

Returns details of an installment or a recurring subscription by the deal ID. Note: Subscriptions endpoints may not be available on company-specific hosts or may be deprecated. This action attempts multiple hosts and gracefully falls back to Installments (v2) or Deal Products (v1) to provide a useful response based on live API data.

Finds users by their name.

Tool to list updates about deal field values. Use when you need to retrieve the changelog history showing all changes made to a specific deal's field values.

Tool to get details of a specific deal in Pipedrive. Use when you need to retrieve comprehensive information about a deal by its ID.

Tool to list files attached to a deal. Use when you need to retrieve all files associated with a specific deal in Pipedrive.

Tool to list mail messages associated with a deal in Pipedrive. Use when you need to retrieve email communications linked to a specific deal. Note: This returns mail message snippets only; for full email content, use the thread_id and query mail threads separately.

Tool to list participants of a deal. Use when you need to retrieve all participants (persons) associated with a specific deal in Pipedrive.

Tool to list updates about participants of a deal. Use when you need to retrieve the changelog history showing all changes made to a specific deal's participants.

Tool to list users permitted to access a deal. Use when you need to retrieve all users who have permission to access a specific deal in Pipedrive.

Tool to list products attached to a deal. Use when you need to retrieve all products associated with a specific deal in Pipedrive.

Tool to retrieve products attached to specified deals (max 100 deals per request). Use when you need to get all products associated with multiple deals.

Tool to list users permitted to access a lead. Use when you need to retrieve all user IDs who have permission to access a specific lead in Pipedrive.

Tool to retrieve marketplace_client_id of an installed video integration. Use when you need the client ID for an installed integration.

Tool to list updates about organization field values. Use when you need to retrieve the changelog history showing all changes made to a specific organization's field values.

Tool to get details of a specific organization in Pipedrive. Use when you need to retrieve comprehensive information about an organization by its ID.

Tool to list files attached to an organization. Use when you need to retrieve all files associated with a specific organization in Pipedrive.

Tool to list followers of an organization. Use when you need to retrieve all users who are following a specific organization in Pipedrive.

Tool to list changelog about organization followers. Use when you need to retrieve the history of users who have followed or unfollowed a specific organization.

Tool to list mail messages associated with an organization. Use when you need to retrieve all email correspondence linked to a specific organization in Pipedrive.

Tool to list persons associated with an organization. Use when you need to retrieve all persons linked to a specific organization in Pipedrive.

Tool to list updates about an organization including field value changes, activities, notes, files, and other related items. Use when you need to retrieve the activity flow and update history for a specific organization.

Tool to list permission set assignments for a given permission set. Use when you need to retrieve all users assigned to a specific permission set.

Tool to list updates about person field values. Use when you need to retrieve the changelog history showing all changes made to a specific person's field values.

Tool to get details of a specific person in Pipedrive. Use when you need to retrieve comprehensive information about a person by their ID.

Tool to list files attached to a person. Use when you need to retrieve all files associated with a specific person in Pipedrive.

Tool to list followers of a person in Pipedrive. Use when you need to retrieve all users who are following a specific person.

Tool to list mail messages associated with a person in Pipedrive. Use when you need to retrieve email communications linked to a specific person contact.

Tool to list users permitted to access a person. Use when you need to retrieve all users who have permission to access a specific person in Pipedrive.

Tool to get picture details of a specific person in Pipedrive. Use when you need to retrieve picture information and URLs for a person by their ID.

Tool to list products associated with a person. Use when you need to retrieve all products linked to a specific person in Pipedrive.

Tool to get deals conversion rates in a pipeline for a given time period. Use when you need stage-to-stage conversion statistics, won conversion rates, or lost conversion rates for a specific pipeline.

Tool to retrieve deal movement statistics within a pipeline for a specified time period. Use when you need to analyze pipeline performance metrics including new deals, won/lost deals, deals left open, and average age statistics.

Tool to list deals associated with a product. Use when you need to retrieve deals that have a specific product attached to them.

Tool to list files attached to a product. Use when you need to retrieve all files associated with a specific product in Pipedrive.

Tool to list changelog of followers for a product. Use when you need to retrieve the history of users who have followed or unfollowed a specific product.

Tool to list users who are following a specific user. Use when you need to retrieve all followers of a user in Pipedrive.

Tool to list role assignments for a user. Use when you need to retrieve all role assignments associated with a specific user in Pipedrive.

Returns data about a specific team.

Tool to retrieve metadata about all activity fields in the company. Use when you need to get information about field structure, types, options, and properties for activities.

Returns all activities assigned to a particular user.

This BETA cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error. Refer to Pipedrive's documentation for pagination and global permissions.

Returns all activity fields.

Returns all activity types.

Returns the add-ons for a single company.

Returns all call logs assigned to a particular user.

Returns all comments associated with a note.

Returns data about all deal fields.

Returns all 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>.

This endpoint returns all deals with cursor pagination (in BETA). Only global admins can access it; others get a 403 error. More info on pagination and permissions is available online.

Returns data about all files.

The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an API. It encourages consulting a tutorial for more details on adding a filter.

Returns data about all filters.

Tool to retrieve all lead fields. Use when you need to get the schema for leads in a company's context.

Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

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.

The API returns sorted leads by creation time, supporting pagination via `limit` and `start`. Custom field values are included if set, mimicking the `Deals` endpoint structure; unset fields are omitted. Leads share custom fields with deals.

Returns all the mail messages inside a specified mail thread.

Returns data about all note fields.

Returns all notes.

Returns data about all organization fields.

Returns all organizations.

This BETA API endpoint lists all organizations with cursor pagination. Only global admins have access; others get a 403 error. See docs for pagination and global permissions.

Returns all payments of an installment or recurring subscription.

Returns data about all permission sets.

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.

Returns all persons.

This BETA endpoint returns all persons, using cursor pagination. Only global admins have access; others get a 403 error. Info on pagination and permissions is in the linked docs.

Returns data about all pipelines.

Returns data about all product fields.

Returns data about all products.

Returns all projects boards that are not deleted. Note: The Projects feature requires the Projects add-on which is available on Power and Enterprise plans, or as a paid add-on for other plans. A 402 Payment Required error indicates the account does not have access to the Projects feature.

The endpoint retrieves all non-deleted project templates with cursor-based pagination. Refer to the provided documentation link for more details on pagination. Note: This endpoint requires the Pipedrive Projects add-on to be enabled. Projects is included in Power and Enterprise plans, or can be purchased as an add-on for Professional plans or lower.

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>.

Gets all of the relationships for a supplied organization ID.

Returns all the roles within the company. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used.

Returns data about all stages.

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.

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>.

Returns data about teams within the company.

Returns data about all teams which have the specified user as a member.

Returns data about all connections for the authorized user.

Returns data about all users within the company.

Returns a list of all user IDs within a team.

Returns data about all the Webhooks of a company.

Tool to get all archived deals from Pipedrive. Use when you need to retrieve deals that have been archived, with support for filtering and pagination.

Tool to retrieve summary statistics for archived deals. Use when you need aggregated data about archived deals including total count, values, and weighted values grouped by currency.

Tool to get all archived leads from Pipedrive. Use when you need to retrieve leads that have been archived, with support for filtering by owner, person, organization, or custom filter, and pagination.

Tool to retrieve details of a specific call log by ID. Use when you need to get complete information about a call log including duration, outcome, participants, and timestamps.

Tool to retrieve messaging conversations. Use after channel registration to sync conversations.

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.

DEPRECATED: Use PIPEDRIVE_PIPEDRIVE_ACTIVITIES_UPDATE_ACTIVITY or PIPEDRIVE_LIST_ACTIVITIES instead. Lists activities associated with a deal. Use when you need to retrieve all activities linked to a specific deal.

Tool to retrieve the conversion status for a deal-to-lead conversion operation. Use when you need to check the progress or result of a deal conversion job.

Lists users who are following the deal. Use when you need to retrieve all followers of a specific deal.

Tool to retrieve changelogs about users who have followed a deal. Use when you need to track follower activity, showing when users were added or removed as followers.

Lists updates about a deal in chronological order. Use when you need to track deal changes, monitor activity timeline, or audit deal modifications.

Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.

Tool to retrieve discounts for a specific deal. Use when you need to list all discounts added to a deal in Pipedrive.

Lists deals in a specific pipeline across all its stages.

Lists deals in a specific stage.

Returns a summary of all the deals.

Returns opened and won deals in time-based groups according to a specified dealField, with examples of deals grouped by month over a 3-month period starting January 2012.

Returns data about deals that have a product attached to it.

Returns the details of a specific project board.

DEPRECATED: Use PIPEDRIVE_PIPEDRIVE_GET_PERSON instead. The text describes an API endpoint that returns detailed person information, including extra fields and custom fields as hashes. It also provides `data.marketing_status` if the Campaigns product is used.

Returns the details of a specific project phase.

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.

Returns details of an installment or a recurring subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action tries multiple hosts and gracefully falls back to Installments (v2) and Deal Products (v1).

Returns the details of a specific task.

Returns the details of a specific project template.

Returns the details of a specific activity.

Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the 'key' value in organizationFields.

Tool to retrieve the conversion status for a specific lead conversion job. Use when you need to check the progress of a lead-to-deal conversion including current state and resulting deal ID upon completion.

Returns mail threads in a specified folder ordered by the most recent message within.

Tool to retrieve detailed metadata for a specific activity field by its field code. Use when you need information about field structure, type, options, or properties.

Returns the details of a comment.

Tool to retrieve a specific deal field by ID. Use when you need to get metadata and configuration for a deal field.

Returns data about a specific file.

Returns data about a specific filter. Note that this also returns the condition lines of the filter.

API returns specific lead details with custom field values in the Deals format. Unset custom fields are omitted. Leads share custom fields with deals, not having a unique set.

Returns data about a specific mail message.

Returns a specific mail thread.

Returns details about a specific note.

Tool to retrieve a specific organization field by ID. Use when you need to get metadata and configuration for an organization field.

Finds and returns an organization relationship from its ID.

Returns data about a specific permission set.

Tool to retrieve metadata for a specific person field by its ID. Use when you need to get field properties like name, type, order, and options.

Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.

Returns data about a specific product.

Returns data about a specific product field.

Tool to retrieve details for a specific role by its ID. Use when you need to get complete role information including name, parent role, active status, assignment count, and default visibility settings.

Returns data about a specific stage.

Returns data about a specific user within the company.

Lists deals associated with an organization. Use when you need to retrieve all deals linked to a specific organization with optional filtering and pagination.

List users permitted to access an organization. Use when you need to retrieve all users who have been granted permission to view and interact with a specific organization record.

Lists deals associated with a person. Use when you need to retrieve all deals linked to a specific person.

Tool to retrieve changelogs about users who have followed a person. Use when you need to track follower activity, showing when users were added or removed as followers.

Lists updates and activity history for a specific person in chronological order. Use when you need to track person changes, monitor activity timeline, or audit person modifications.

Tool to list all followers of a product in Pipedrive. Use when you need to retrieve users following a specific product. Returns pagination metadata to handle large follower lists.

Tool to retrieve image data for a specific product. Use when you need to get the public URL and metadata for a product's image. Note that public URLs have a limited lifetime of 7 days.

Tool to retrieve all product variations for a specific product with pagination support. Use when you need to get the complete list of variations available for a product, each with different prices across currencies.

Returns all active project phases under a specific board.

Returns data about all recent changes occurred after the given timestamp.

Gets the progress of a goal for the specified period.

Tool to retrieve all users assigned to a specific role in Pipedrive. Use when you need to list role assignments for a given role.

Returns the visibility settings for pipelines associated with a specific role. Use when you need to list which pipelines are visible or hidden for a role.

Tool to retrieve visibility settings of a specific role. Use when you need to get default visibility levels and access levels for deals, leads, organizations, people, and products associated with a role. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the provided base_url to use `/api/v1` to avoid host/path mismatches.

Tool to retrieve message templates for a channel. Use when template support is enabled.

Tool to list user role settings. Use when you need to retrieve the role configuration data for a specific user, including default visibility levels and access levels for various entities. Note: This endpoint costs 10 API credits per request.

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.

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>.

List users permitted to access a person.

Lists users permitted to access a product.

Lists role assignments for a user.

Lists activities associated with a deal.

Lists activities associated with a person.

Lists activities associated with an organization.

The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing_status` field for users of the Campaigns product.

Lists deals associated with a person.

Lists deals associated with an organization.

Lists files associated with a deal.

Lists files associated with a person.

Lists files associated with a product.

Lists files associated with an organization.

Lists the followers of a deal.

Lists the followers of a person.

Lists the followers of a product.

Lists the followers of a specific user.

Lists the followers of an organization.

Lists mail messages associated with a deal.

Lists mail messages associated with a person.

Lists mail messages associated with an organization.

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.

Returns the list of assignments for a permission set. Notes: - This endpoint requires the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/permissionSets/{id}/assignments - This action normalizes the base URL accordingly and returns the API envelope even on errors.

Lists the users permitted to access a deal.

Tool to list users permitted to access a product in Pipedrive. Use when you need to retrieve the list of users who have permission to view or manage a specific product.

Lists persons associated with an organization.<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.

Returns a list of visible or hidden pipeline IDs by role. See the "Visibility groups article" for details on pipeline visibility.

Lists products associated with a person.

Lists products attached to a deal.

Returns all users assigned to a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/assignments - This action normalizes the base URL accordingly.

Returns the visibility settings of a specific role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the base URL accordingly.

Lists the settings of an authorized user. Example response contains a shortened list of settings.

Lists updates about a deal.

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.

Lists updates about an organization.

This endpoint provides cursor-paginated updates on deal participants. For pagination details, see the Pipedrive documentation.

Lists aggregated permissions over all assigned permission sets for a user.

Tool to list aggregated permissions over all assigned permission sets for a user. Use when you need to check what capabilities and access rights a specific user has across the system.

Lists the settings of user's assigned role.

Tool to merge two deals in Pipedrive. Use when you need to consolidate two deals into one. The deal specified by 'id' will be merged into the deal specified by 'merge_with_id', and the first deal will be removed while the second one will remain with all consolidated data.

Tool to merge two organizations in Pipedrive. Use when you need to consolidate two organizations into one. The organization specified by 'id' will be merged into the organization specified by 'merge_with_id', and the first organization will be removed while the second one will remain with all consolidated data.

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>.

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>.

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>.

Tool to merge two persons in Pipedrive. Use when you need to combine two person records into one. The person ID specified in the request will be merged and removed, while the merge_with_id person will remain. When data conflicts exist, the merge_with_id person's field data takes priority.

List users permitted to access an organization.

Updates an existing deal custom field using PATCH method. Use when you need to modify field properties like name, visibility, or validation rules. Note that field code and type are immutable and cannot be changed.

Performs a search from your choice of item types and fields.

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).

Access tokens expire after the time specified in `expires_in`. To continue accessing the API, use the `refresh_token` to obtain a new access token.

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.

Returns activities linked to a specific project.

Returns all active groups under a specific project.

Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.

Returns tasks linked to a specific project.

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).

This API endpoint searches deals by title, notes, and custom fields, filters results by person or organization ID, and is a specific use case of /v1/itemSearch with limited OAuth scope.

Endpoint searches leads by title, notes, custom fields, with options to filter by person and organization IDs, and is a more specific use of the /v1/itemSearch with limited OAuth scope.

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.

This endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemSearch with limited OAuth scope, allowing results filtering by organization ID.

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.

A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.

Updates a product attached to a deal with new values. Use when you need to modify price, quantity, discount, tax, or other properties of a deal product.

Tool to update a lead label in Pipedrive. Use when you need to modify the name or color of an existing lead label. Only properties included in the request will be updated.

Tool to update an existing note in Pipedrive. Use when you need to modify the content or properties of a note attached to deals, persons, organizations, leads, or projects.

Tool to update an existing organization in Pipedrive. Use when you need to modify organization properties such as name, owner, visibility, labels, or address.

Tool to update person field configuration in Pipedrive. Use when you need to modify field properties like name, description, visibility settings, or requirement status. Only provided properties will be updated; omitted properties retain their existing values. Note: field_code and field_type cannot be changed.

Updates a comment related to a note.

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>.

Tool to update an existing deal in Pipedrive. Use when you need to modify properties of a deal such as title, value, status, stage, or associated contacts/organizations.

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>.

Tool to update a deal field in Pipedrive. Use when you need to modify existing deal field properties such as name, visibility, or options. Note that field_code and field_type cannot be changed.

Updates an existing filter in Pipedrive. Use when you need to modify filter name or conditions. Maximum of 16 conditions per filter allowed.

Tool to update a lead in Pipedrive. Use when you need to modify properties of an existing lead such as title, value, status, or linked contacts.

Updating lead properties modifies only specified fields; use `null` to unset. Custom field data matches `Deals`. Unset fields are omitted. Leads share deals' custom fields. For examples, refer to the tutorial.

Updates one or more properties of a lead label. Only properties included in the request will be updated.

Updates a note.

Modifies a person’s details in Pipedrive. See the linked tutorial for guidance. If utilizing Campaigns, the endpoint also handles `data.marketing_status`.

Tool to update a person's properties in Pipedrive. Use when you need to modify existing person details such as name, contact information, owner, or organization.

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>.

Tool to update a pipeline in Pipedrive. Use when you need to modify pipeline properties like name, deal probability, order, or active status. All fields except id are optional - only include the fields you want to update.

Updates the properties of a pipeline (v2).

Updates product data.

Tool to update a product in Pipedrive. Use when you need to modify product details like name, code, price, tax, or other attributes.

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>.

Updates a project.

Updates a recurring subscription. Note: Some company hosts may not expose Subscriptions endpoints. This action will attempt multiple hosts and gracefully fall back to updating the product attached to a deal (v1) when applicable. In the fallback path, the request `id` is treated as the `product_attachment_id` and we locate the corresponding deal by scanning deal products.

Updates a task.

Updates an existing team and returns the updated object.

Updates an activity phase or group in a project.

Tool to update an activity type in Pipedrive. Use when you need to modify the name, icon, color, or order of an existing activity type.

Tool to update an existing activity in Pipedrive including scheduling, assignments, descriptions, and participants. Use when you need to modify any properties of an activity such as subject, due date/time, status, or associated entities.

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).

Updates an activity type.

Updates an installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action overrides the default request behavior and uses multiple hosts along with a practical fallback to Deal Products when Subscriptions/Installments features are not accessible.

Updates the properties of an organization.

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>.

Updates and returns an organization relationship.

Tool to update a comment on a note in Pipedrive. Use when you need to modify the content of an existing comment attached to a note.

Tool to update an existing deal using Pipedrive v2 API. Use when you need to modify deal properties including custom fields, archive status, or deletion status.

Tool to update a discount for a specific deal. Use when you need to modify the amount, description, or type of an existing discount added to a deal in Pipedrive.

Tool to update existing options for a deal custom field atomically. Use when you need to modify labels of options in a deal field.

Tool to update product details attached to a deal in Pipedrive using the v2 API. Use when you need to modify product attributes like price, quantity, discount, or tax for a deal-product attachment.

Updates an existing goal. Note: For OAuth, Goals API is available under {companydomain}/api/v1. The platform metadata base_url may be {companydomain}/v1, which yields 404 for PUT /goals/{id}. We therefore construct the URL using the company domain and /api/v1 explicitly.

Updates the properties of a file including its visible name and description. Use when you need to modify file metadata in Pipedrive.

Updates the properties of a file.

Updates an existing filter.

Updates the properties of a mail thread.

Tool to update an organization field in Pipedrive. Use when you need to modify the name, options, or visibility of an existing organization field.

Tool to update an existing organization field in Pipedrive using the v2 API. Use when you need to modify field name, UI visibility, importance settings, required field settings, or description.

Tool to update existing options for an organization custom field atomically. Use when you need to modify option labels for an organization field. All specified option IDs must exist or the entire request fails.

Tool to update an organization relationship in Pipedrive. Use when you need to modify the type or organizations involved in an existing relationship between two organizations.

Tool to update a person's properties in Pipedrive using the v2 API. Use when you need to modify existing person details such as name, contact information, owner, or organization.

Tool to update a person field in Pipedrive. Use when you need to modify the name, options, or visibility settings of an existing person field.

Tool to update existing options for a person custom field atomically. Use when you need to modify labels of options in a person field.

Updates pipeline visibility settings for different roles. For details, see the Pipedrive Visibility groups article.

Tool to update a product custom field. Use when you need to modify field name, UI visibility, or description. The field_code and field_type cannot be changed. At least one field must be provided in the request.

Tool to update a product field definition in Pipedrive. Use when you need to modify the name or options of an existing product custom field.

Tool to update existing options for a product custom field atomically. Use when you need to modify labels of options in a product field.

Tool to update an image for a product in Pipedrive. Use when you need to add or replace a product image.

Tool to update a product variation in Pipedrive. Use when you need to modify variation details like name or prices across different currencies.

Updates the parent role and/or the name of a specific role. Notes: - Roles endpoints require the `admin` scope. - With OAuth (Bearer) tokens, Pipedrive expects the company domain base URL with `/api/v1` path, e.g. https://{COMPANY}.pipedrive.com/api/v1/roles/{id} - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used with the company domain when available. Falls back to the global API host otherwise.

Updates pipeline visibility for a role. Use when you need to control which sales pipelines are accessible to users within a particular role group.

Tool to update an existing stage in Pipedrive. Use when you need to modify stage properties such as name, deal probability, or rotten deal settings.

Tool to update stage details in Pipedrive. Use when you need to modify properties of an existing stage such as name, pipeline association, deal probability, or rotten deal settings.

Updates the properties of a stage.

Updates a task phase or group in a project.

Updates the details of the product that has been attached to a deal.

Tool to update user details in Pipedrive. Use when you need to activate or deactivate a user account. Requires admin-level permissions.

Updates the properties of a user. Currently, only `active_flag` can be updated.

Triggered when a new deal is created in Pipedrive

Triggered when a new note is created in Pipedrive

Triggered when a new organization is created in Pipedrive