Pipedrive

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

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

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

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

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'

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 m

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 fie

Adds a follower to a deal.

Adds a participant to a deal.

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

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 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://pipedr

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

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

Creates a lead label.

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

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 cu

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 f

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 1

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

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

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 recogn

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/

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

Adds a new stage, returns the ID upon success.

Adds a new task.

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

Adds users to an existing team.

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

Archives a project.

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

Creates and returns an organization relationship.

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

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

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

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 fiel

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

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

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 permanent

Marks multiple activity types as deleted.

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

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, plea

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://pipedr

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 deal field in Pipedrive by marking it as deleted. Use when you need to remove a custom deal field.

Marks multiple deal fields as deleted.

Deletes a participant from a deal.

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

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.

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

Marks multiple filters as deleted.

Deletes a specific lead.

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.

Deletes a specific note.

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 fiel

Deletes an organization relationship and returns the deleted ID.

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

Deletes a follower from a person.

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-

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

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 cus

Deletes a follower from a product.

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 an installment or a recurring subscription as deleted.

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

Deletes users from an existing team.

Deletes the specified Webhook.

Initializes a file download.

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`

Finds users by their name.

Returns the details of a specific activity.

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 permis

Returns all activity fields.

Returns all activity types.

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 fil

Returns data about all filters.

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 omitte

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

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. This action retrieves all pipelines from the user's Pipedrive instance using their instance-specific URL (e.g., https://company.pipedrive.com/api/v2/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 P

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 Pipedri

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="_b

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://{CO

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 I

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="_blan

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.

Returns the details of a comment.

Returns the add-ons for a single company.

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 acco

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

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.

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 provide

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 organizationField

Returns data about a specific file.

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

Gets the progress of a goal for the specified period.

Returns data about a specific mail message.

Returns a specific mail thread.

Returns all the mail messages inside a specified mail thread.

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

Returns details about a specific note.

Returns all comments associated with a note.

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.

Finds and returns an organization relationship from its ID.

Returns data about a specific permission set.

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.

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 the details of a specific project board.

Returns the details of a specific project phase.

Returns all active project phases under a specific board.

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

Returns data about a specific stage.

Returns all payments of an installment or recurring subscription.

Returns the details of a specific task.

Returns data about a specific team.

Returns the details of a specific project template.

Returns data about a specific user within the company.

Returns all call logs assigned to a particular user.

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="no

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.

Lists activities associated with a deal.

Lists files associated with a deal.

Lists the followers of a deal.

Lists mail messages associated with a deal.

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 products attached to a deal.

Lists updates about a deal.

Lists the users permitted to access a deal.

Lists activities associated with an organization.

Lists deals associated with an organization.

Lists files associated with an organization.

Lists the followers of an organization.

Lists mail messages associated with an organization.

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.

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.

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}

Lists activities associated with a person.

Lists deals associated with a person.

Lists files associated with a person.

Lists the followers of a person.

Lists mail messages associated with a person.

Lists products associated with a person.

List users permitted to access a person.

Lists files associated with a product.

Lists the followers of a product.

Lists users permitted to access a product.

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/

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

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

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

Lists updates about an organization.

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

Lists the followers of a specific user.

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

Lists role assignments for a user.

Lists the settings of user's assigned role.

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

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 noreferr

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 per

List users permitted to access an organization.

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 install

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.

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

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.

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

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

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

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

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

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 field

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

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

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 fie

Updates the properties of a pipeline (v2).

Updates product data.

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 f

Updates an activity phase or group in a project.

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, per

Updates an activity type.

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 cu

Updates and returns an organization relationship.

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

Updates the properties of a file.

Updates an existing filter.

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 mul

Updates the properties of a mail thread.

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

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

Updates the properties of a stage.

Updates a task.

Updates a task phase or group in a project.

Updates an existing team and returns the updated object.

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