Pipedrive

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 comment to a note.

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

Adds a follower to a deal.

Adds a follower to a person.

Adds a follower to a product.

Adds a follower to an organization.

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

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

Adds a new pipeline.

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

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

Adds a product to a deal, creating a new item called a deal-product.

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.

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

Adds a new installment subscription.

Set up a new pipedrive organization using custom fields with unique key hashes. retrieve `organizationfields` for configuration. check the linked tutorial for guidance.

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

Adds a new activity type.

Adds or updates the visibility setting for a role.

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

Assigns a user to a role.

Adds users to an existing team.

Archives a project.

Adds an audio recording to the call log. that audio can be played by those who have access to the call log object.

Cancels a recurring subscription.

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

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.

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

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

Marks a deal as deleted. after 30 days, the deal 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 file as deleted. after 30 days, the file will be permanently deleted.

Marks a filter as deleted.

Deletes a follower from a deal.

Deletes a follower from a person.

Deletes a follower from a product.

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

Deletes a specific lead.

Deletes a specific lead label.

Deletes a specific note.

Deletes a participant from a deal.

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

Marks a project as deleted.

Marks a role as deleted.

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

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

Marks an activity type as deleted.

Deletes a product attachment from a deal, using the `product attachment id`.

Marks an organization as deleted. after 30 days, the organization 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

Deletes an organization relationship and returns the deleted id.

Marks a goal as deleted.

Deletes the specified webhook.

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.

Deletes a person’s picture.

Deletes users from an existing team.

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`

Returns details of an installment or a recurring subscription by the deal id.

Finds users by their name.

Returns data about a specific team.

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

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.

The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.

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.

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 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 statistics for deals movements for the given time period.

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.

Returns details of a specific call log.

Fetches specific deal details, including exclusive fields like deal age and pipeline stage duration. custom fields show up as hashes, which can be matched using the 'key' from dealfields. see the deal

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 us

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.

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 organizationfield

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

Returns the details of a comment.

Returns data about a specific 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.

Returns data about a specific organization field.

Finds and returns an organization relationship from its id.

Returns data about a specific permission set.

Returns data about a specific person field.

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

Returns data about a specific stage.

Returns data about a specific user within the company.

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.

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

Returns the list of assignments for a permission set.

Lists the users permitted to access a deal.

List users permitted to access a person.

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.

Returns a list of visible or hidden pipeline ids by role. see the "visibility groups article" for details on pipeline visibility.

Lists users permitted to access a product.

Lists products associated with a person.

Lists products attached to a deal.

Returns all users assigned to a role.

Returns the visibility settings of a specific role.

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

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.

Lists the settings of user's assigned role.

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.

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

Lists role assignments for a user.

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

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

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.

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.

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 fiel

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 fi

Updates the properties of a pipeline.

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

Updates a recurring subscription.

Updates a task.

Updates an existing team and returns the updated object.

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 an installment subscription.

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 an existing goal.

Updates the properties of a file.

Updates an existing filter.

Updates the properties of a mail thread.

Updates pipeline visibility settings for different roles. for details, see the pipedrive visibility groups article.

Updates the parent role and/or the name of a specific role.

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.

Updates the properties of a user. currently, only `active flag` can be updated.