<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">September 21, 2020</span>
    </div>
    <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-endpoints-in-products-full-scope"></div>
        <div class="heading-text"><div id="new-endpoints-in-products-full-scope" class="heading-anchor_backwardsCompatibility">
          </div>New endpoints in <code>products:full</code> scope</div>
        <a aria-label="Skip link to New endpoints in products:full scope" class="heading-anchor-icon fa fa-anchor" 
           href="#new-endpoints-in-products-full-scope"></a></h3>
      
       
      <p><code>Products:full</code> scope now allows apps to have access to 2 new endpoints.</p>
      <p> By selecting the <code>products:full</code> scope, an app can now have access to the 2 following endpoints, which allow the app to add or remove followers from products:</p>
<ul>
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#addProductFollower" target="_self">POST /products/{id}/followers</a></code></li>
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#deleteProductFollower" target="_self">DELETE /products/{id}/followers/{id}</a></code></li>
      </ul>
<p>You can read more about the scopes and permission explanations <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">here</a>.</p> 
     <p>If you wish to add or remove scopes of an already approved or published app, be sure to <a href="https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes">learn how changing the scopes will affect your app's existing users</a>.</p>


      
      <p class="published-on"><i>Published on September 21, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["Authentication"], "features": ["Scopes"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">September 21, 2020</span>
    </div>
    <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-endpoints-in-products-full-scope"></div>
        <div class="heading-text"><div id="new-endpoints-in-products-full-scope" class="heading-anchor_backwardsCompatibility">
          </div>New endpoints in <code>products:full</code> scope</div>
        <a aria-label="Skip link to New endpoints in products:full scope" class="heading-anchor-icon fa fa-anchor" 
           href="#new-endpoints-in-products-full-scope"></a></h3>
      
       
      <p><code>Products:full</code> scope now allows apps to have access to 2 new endpoints.</p>
      <p> By selecting the <code>products:full</code> scope, an app can now have access to the 2 following endpoints, which allow the app to add or remove followers from products:</p>
<ul>
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#addProductFollower" target="_self">POST /products/{id}/followers</a></code></li>
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#deleteProductFollower" target="_self">DELETE /products/{id}/followers/{id}</a></code></li>
      </ul>
<p>You can read more about the scopes and permission explanations <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">here</a>.</p> 
     <p>If you wish to add or remove scopes of an already approved or published app, be sure to <a href="https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes">learn how changing the scopes will affect your app's existing users</a>.</p>


      
      <p class="published-on"><i>Published on September 21, 2020</i></p>
    </div>
</div>


New endpoints in <code>products:full</code> scope

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">September 21, 2020</span>
    </div>
    <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="fix-in-post-subscriptions-recurring-endpoint-documentation"></div>
        <div class="heading-text"><div id="fix-in-post-subscriptions-recurring-endpoint-documentation" class="heading-anchor_backwardsCompatibility">
          </div>Fix in <code>POST /subscriptions/recurring</code> endpoint documentation</div>
        <a aria-label="Skip link to Fix in POST /subscriptions/recurring endpoint documentation" class="heading-anchor-icon fa fa-anchor" 
           href="#fix-in-post-subscriptions-recurring-endpoint-documentation"></a></h3>
      
      
        

      <p>We had the <code>payments</code> parameter marked as required in the documentation of <code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#addRecurringSubscription">POST /subscriptions/recurring</a></code> endpoint in our API Reference, but under the hood it is not a required parameter. We have now removed the required flag (a red asterisk) from the <code>payments</code> parameter.</p>

  <p class="published-on"><i>Published on September 21, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API"], "features": ["Subscriptions"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">September 21, 2020</span>
    </div>
    <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="fix-in-post-subscriptions-recurring-endpoint-documentation"></div>
        <div class="heading-text"><div id="fix-in-post-subscriptions-recurring-endpoint-documentation" class="heading-anchor_backwardsCompatibility">
          </div>Fix in <code>POST /subscriptions/recurring</code> endpoint documentation</div>
        <a aria-label="Skip link to Fix in POST /subscriptions/recurring endpoint documentation" class="heading-anchor-icon fa fa-anchor" 
           href="#fix-in-post-subscriptions-recurring-endpoint-documentation"></a></h3>
      
      
        

      <p>We had the <code>payments</code> parameter marked as required in the documentation of <code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#addRecurringSubscription">POST /subscriptions/recurring</a></code> endpoint in our API Reference, but under the hood it is not a required parameter. We have now removed the required flag (a red asterisk) from the <code>payments</code> parameter.</p>

  <p class="published-on"><i>Published on September 21, 2020</i></p>
    </div>
</div>


Fix in <code>POST /subscriptions/recurring</code> endpoint documentation

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 7, 2020</span>
    </div>
    <div class="change-area">
       <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-parameter-in-two-deals-endpoints"></div>
        <div class="heading-text"><div id="new-parameter-in-two-deals-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>New parameter in two Deals endpoints</div>
        <a aria-label="Skip link to New parameter in two Deals endpoints" class="heading-anchor-icon fa fa-anchor" 
           href="#new-parameter-in-two-deals-endpoints"></a></h3>
        
      <p>We have added a new parameter <code>expected_close_date</code> to the <code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal">PUT /deals/{id}</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeal">POST /deals</a></code> endpoints.</p>
      
      <p>The <code>expected_close_date</code> parameter allows you to change the date of when the Deal is expected to be marked as won.</p>
  
				
        <p class="published-on"><i>Published on August 7, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API"], "features": ["Deals"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 7, 2020</span>
    </div>
    <div class="change-area">
       <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-parameter-in-two-deals-endpoints"></div>
        <div class="heading-text"><div id="new-parameter-in-two-deals-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>New parameter in two Deals endpoints</div>
        <a aria-label="Skip link to New parameter in two Deals endpoints" class="heading-anchor-icon fa fa-anchor" 
           href="#new-parameter-in-two-deals-endpoints"></a></h3>
        
      <p>We have added a new parameter <code>expected_close_date</code> to the <code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal">PUT /deals/{id}</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeal">POST /deals</a></code> endpoints.</p>
      
      <p>The <code>expected_close_date</code> parameter allows you to change the date of when the Deal is expected to be marked as won.</p>
  
				
        <p class="published-on"><i>Published on August 7, 2020</i></p>
    </div>
</div>


New parameter in two Deals endpoints

<HTMLBlock>{`
 <div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 6, 2020</span>
    </div>
    <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="introducing-subscriptions-api"></div>
        <div class="heading-text"><div id="introducing-subscriptions-api" class="heading-anchor_backwardsCompatibility">
          </div>Introducing Subscriptions APIs</div>
        <a aria-label="Skip link to Introducing Subscriptions API" class="heading-anchor-icon fa fa-anchor" 
           href="#introducing-subscriptions-api"></a></h3>
      
      
      <p>We have added a brand new <code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions
        ">Subscriptions</a></code> resource to our API which represents the Recurring Revenue feature inside Pipedrive. </p>
      
 <p>Subscriptions represent the revenue that is occurring over time with payments either in set or varying amounts. Subscriptions have two types - installment and recurring.
Installment Subscription occurs over time with payments in varying amounts and payment dates.
Recurring Subscription occurs over fixed intervals of time with payments of the same amount.
</p>
<p>The Subscriptions resource includes the following endpoints:</p>
<ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#getSubscription">GET /subscriptions/{id}</a></code></li>
  
				<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#findSubscriptionByDeal">GET /subscriptions/find/{dealId}</a></code></li>
				
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#getSubscriptionPayments">GET /subscriptions/{id}/payments</a></code></li>
					
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#addRecurringSubscription">POST /subscriptions/recurring</a></code></li>
      
      <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#addSubscriptionInstallment">POST /subscriptions/installment</a></code></li>
  
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#updateRecurringSubscription">PUT /subscriptions/recurring/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#updateSubscriptionInstallment">PUT /subscriptions/installment/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#cancelRecurringSubscription">PUT /subscriptions/recurring/{id}/cancel</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#deleteSubscription">DELETE /subscriptions/{id}</a></code></li>
 
  
      </ul><br>
      <p>To be able to use an endpoint using <a href="https://pipedrive.readme.io/docs/marketplace-oauth-authorization">OAuth authorization</a>, the endpoint needs to be added to a scope. We have added the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/#!/Subscriptions">Subscriptions</a></code> resource to our <code>deals:read</code> and <code>deals:full</code> scopes.
You can read more about the scopes and permission explanations <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">here</a>.</p>
    <p>If you wish to update the scopes of an already approved or published app, be sure to <a href="https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes">learn how changing the scopes will affect your existing users</a>.</p>

      
     <p class="published-on"><i>Published on August 6, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API", "Authentication"], "features": ["Deals"]}


 <div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 6, 2020</span>
    </div>
    <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="introducing-subscriptions-api"></div>
        <div class="heading-text"><div id="introducing-subscriptions-api" class="heading-anchor_backwardsCompatibility">
          </div>Introducing Subscriptions APIs</div>
        <a aria-label="Skip link to Introducing Subscriptions API" class="heading-anchor-icon fa fa-anchor" 
           href="#introducing-subscriptions-api"></a></h3>
      
      
      <p>We have added a brand new <code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions
        ">Subscriptions</a></code> resource to our API which represents the Recurring Revenue feature inside Pipedrive. </p>
      
 <p>Subscriptions represent the revenue that is occurring over time with payments either in set or varying amounts. Subscriptions have two types - installment and recurring.
Installment Subscription occurs over time with payments in varying amounts and payment dates.
Recurring Subscription occurs over fixed intervals of time with payments of the same amount.
</p>
<p>The Subscriptions resource includes the following endpoints:</p>
<ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#getSubscription">GET /subscriptions/{id}</a></code></li>
  
				<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#findSubscriptionByDeal">GET /subscriptions/find/{dealId}</a></code></li>
				
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#getSubscriptionPayments">GET /subscriptions/{id}/payments</a></code></li>
					
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#addRecurringSubscription">POST /subscriptions/recurring</a></code></li>
      
      <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#addSubscriptionInstallment">POST /subscriptions/installment</a></code></li>
  
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#updateRecurringSubscription">PUT /subscriptions/recurring/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#updateSubscriptionInstallment">PUT /subscriptions/installment/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#cancelRecurringSubscription">PUT /subscriptions/recurring/{id}/cancel</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Subscriptions#deleteSubscription">DELETE /subscriptions/{id}</a></code></li>
 
  
      </ul><br>
      <p>To be able to use an endpoint using <a href="https://pipedrive.readme.io/docs/marketplace-oauth-authorization">OAuth authorization</a>, the endpoint needs to be added to a scope. We have added the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/#!/Subscriptions">Subscriptions</a></code> resource to our <code>deals:read</code> and <code>deals:full</code> scopes.
You can read more about the scopes and permission explanations <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">here</a>.</p>
    <p>If you wish to update the scopes of an already approved or published app, be sure to <a href="https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes">learn how changing the scopes will affect your existing users</a>.</p>

      
     <p class="published-on"><i>Published on August 6, 2020</i></p>
    </div>
</div>


Introducing Subscriptions APIs

<HTMLBlock>{`
 <div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 23, 2020</span>
    </div>
   <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="introducing-leads-api"></div>
        <div class="heading-text"><div id="introducing-leads-api" class="heading-anchor_backwardsCompatibility">
          </div>Introducing Leads API</div>
        <a aria-label="Skip link to Introducing Leads API" class="heading-anchor-icon fa fa-anchor" 
           href="#introducing-leads-api"></a></h3>
   

      <p>We have added a brand new <a href="https://developers.pipedrive.com/docs/api/v1/Leads
        ">Leads</a> resource to our Pipedrive API. </p>
 <p>In the sales world, Leads are potential Deals that are stored separately in the Leads Inbox within Pipedrive. </p> 
      
      <p>The Leads resource allows you to get, create, update and delete Leads, Lead Labels and get Lead Sources. </p>
 
 <p> In API requests, each Lead needs to be named (using the <code>title</code> field) and <b>be linked to either a Person or an Organization</b>. Linking to either a Person or an Organization is required in order to keep all the information regarding Contacts in one part of Pipedrive, instead of separating it between Contacts and Leads Inbox, as it is crucial information in sales peoples' daily work. This way all the communication between the sales person and the contact can be found in one place (Person or Organization detail view in Pipedrive) through the entire sales cycle.</p>
   
   <p>Leads can contain the same custom fields as the custom fields of a Deal. If the value of a custom field has been set for a Lead, it will appear in the response of the request.</p>


<p>The Leads resource includes the following endpoints:</p>
<ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLeads">GET /leads</a></code></li>
  
				<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLead">GET /leads/{id}</a></code></li>
				
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#getLeadLabels">GET /leadLabels</a></code></li>
					
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads/">GET /leadLabels/{id}</a></code></li>
      
      <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadSources#getLeadSources">GET /leadSources</a></code></li>
  
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#addLead">POST /leads</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#addLeadLabel">POST /leadLabels</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#deleteLead">DELETE /leads/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#deleteLeadLabel">DELETE /leadLabels/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#updateLead">PATCH /leads/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#updateLeadLabel">PATCH /leadLabels/{id}</a></code></li>
  
      </ul><br>
      <p><code>POST</code> and <code>PATCH</code> requests made to the Leads endpoints must be done using <code>content-type: application/json</code>.</p>

      <p>Please note that <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">the OAuth scope</a> is currently not available for the Leads endpoints, but we are working to get it added.</p>
     <p class="published-on"><i>Published on July 23, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API"], "features": ["Leads"]}


 <div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 23, 2020</span>
    </div>
   <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="introducing-leads-api"></div>
        <div class="heading-text"><div id="introducing-leads-api" class="heading-anchor_backwardsCompatibility">
          </div>Introducing Leads API</div>
        <a aria-label="Skip link to Introducing Leads API" class="heading-anchor-icon fa fa-anchor" 
           href="#introducing-leads-api"></a></h3>
   

      <p>We have added a brand new <a href="https://developers.pipedrive.com/docs/api/v1/Leads
        ">Leads</a> resource to our Pipedrive API. </p>
 <p>In the sales world, Leads are potential Deals that are stored separately in the Leads Inbox within Pipedrive. </p> 
      
      <p>The Leads resource allows you to get, create, update and delete Leads, Lead Labels and get Lead Sources. </p>
 
 <p> In API requests, each Lead needs to be named (using the <code>title</code> field) and <b>be linked to either a Person or an Organization</b>. Linking to either a Person or an Organization is required in order to keep all the information regarding Contacts in one part of Pipedrive, instead of separating it between Contacts and Leads Inbox, as it is crucial information in sales peoples' daily work. This way all the communication between the sales person and the contact can be found in one place (Person or Organization detail view in Pipedrive) through the entire sales cycle.</p>
   
   <p>Leads can contain the same custom fields as the custom fields of a Deal. If the value of a custom field has been set for a Lead, it will appear in the response of the request.</p>


<p>The Leads resource includes the following endpoints:</p>
<ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLeads">GET /leads</a></code></li>
  
				<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLead">GET /leads/{id}</a></code></li>
				
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#getLeadLabels">GET /leadLabels</a></code></li>
					
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads/">GET /leadLabels/{id}</a></code></li>
      
      <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadSources#getLeadSources">GET /leadSources</a></code></li>
  
  <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#addLead">POST /leads</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#addLeadLabel">POST /leadLabels</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#deleteLead">DELETE /leads/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#deleteLeadLabel">DELETE /leadLabels/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#updateLead">PATCH /leads/{id}</a></code></li>
  
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/LeadLabels#updateLeadLabel">PATCH /leadLabels/{id}</a></code></li>
  
      </ul><br>
      <p><code>POST</code> and <code>PATCH</code> requests made to the Leads endpoints must be done using <code>content-type: application/json</code>.</p>

      <p>Please note that <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">the OAuth scope</a> is currently not available for the Leads endpoints, but we are working to get it added.</p>
     <p class="published-on"><i>Published on July 23, 2020</i></p>
    </div>
</div>


Introducing Leads API

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 14, 2020</span>
    </div>
   <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="improved-protection-of-user-data"></div>
        <div class="heading-text"><div id="improved-protection-of-user-data" class="heading-anchor_backwardsCompatibility">
          </div>Improved protection of user data </div>
        <a aria-label="Skip link to Improved protection of user data " class="heading-anchor-icon fa fa-anchor" 
           href="#improved-protection-of-user-data"></a></h3>
 
      <p>We have now improved the security of user data.</p>
      
      <p><b>What has changed?</b></p>
      <p>When returning the <code>User</code> object, the following API endpoints</p>
<ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#getUsers">GET /users</a></code></li>
  
				<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#getUser">GET /users/{id}</a></code></li>
				
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#addUser">POST /users</a></code></li>
					
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#updateUser">PUT /users/{id}</a></code></li></ul><br>

      <p>will have all fields except for <code>id</code>, <code>name</code> and <code>email</code> set to <code>null</code>  if the user is unverified in the company (which is always the case for the <code>POST /users</code> endpoint).</p>
      
      <p>This also affects endpoints of other entities such as Deals, Persons, Organizations, Notes, etc., which may contain related User objects.</p>
      
      <p><b>Who is affected?</b></p>
      <p>Anyone with functionality built on top of the previous behaviour, for example: anyone who strictly relies on the values in the response of the aforementioned endpoints and related webhooks.</p>
      
      <p>The list of affected fields in <code>User</code> endpoints:</p>
<ul>
  <li><code>phone: string</code></li>
  <li><code>created: string (date)</code></li>
  <li><code>modified: string (date)</code></li>
  <li><code>default_currency: string</code></li>
  <li><code>locale: string</code></li>
  <li><code>lang: int</code></li>
  <li><code>timezone_name: string</code></li>
  <li><code>timezone_offset: string</code></li>
  <li><code>signup_flow_variation: string</code></li>
  <li><code>icon_url: string</code></li></ul><br>
  
<p>The field <code>lang</code> will return the default value of <code>1</code>.</p>
  
				
        <p class="published-on"><i>Published on July 14, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API", "Webhooks"], "features": ["Users"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 14, 2020</span>
    </div>
   <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="improved-protection-of-user-data"></div>
        <div class="heading-text"><div id="improved-protection-of-user-data" class="heading-anchor_backwardsCompatibility">
          </div>Improved protection of user data </div>
        <a aria-label="Skip link to Improved protection of user data " class="heading-anchor-icon fa fa-anchor" 
           href="#improved-protection-of-user-data"></a></h3>
 
      <p>We have now improved the security of user data.</p>
      
      <p><b>What has changed?</b></p>
      <p>When returning the <code>User</code> object, the following API endpoints</p>
<ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#getUsers">GET /users</a></code></li>
  
				<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#getUser">GET /users/{id}</a></code></li>
				
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#addUser">POST /users</a></code></li>
					
  			<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#updateUser">PUT /users/{id}</a></code></li></ul><br>

      <p>will have all fields except for <code>id</code>, <code>name</code> and <code>email</code> set to <code>null</code>  if the user is unverified in the company (which is always the case for the <code>POST /users</code> endpoint).</p>
      
      <p>This also affects endpoints of other entities such as Deals, Persons, Organizations, Notes, etc., which may contain related User objects.</p>
      
      <p><b>Who is affected?</b></p>
      <p>Anyone with functionality built on top of the previous behaviour, for example: anyone who strictly relies on the values in the response of the aforementioned endpoints and related webhooks.</p>
      
      <p>The list of affected fields in <code>User</code> endpoints:</p>
<ul>
  <li><code>phone: string</code></li>
  <li><code>created: string (date)</code></li>
  <li><code>modified: string (date)</code></li>
  <li><code>default_currency: string</code></li>
  <li><code>locale: string</code></li>
  <li><code>lang: int</code></li>
  <li><code>timezone_name: string</code></li>
  <li><code>timezone_offset: string</code></li>
  <li><code>signup_flow_variation: string</code></li>
  <li><code>icon_url: string</code></li></ul><br>
  
<p>The field <code>lang</code> will return the default value of <code>1</code>.</p>
  
				
        <p class="published-on"><i>Published on July 14, 2020</i></p>
    </div>
</div>


Improved protection of user data

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 1, 2020</span>
    </div>
     <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="removal-of-additional-data-and-pagination-objects-from-3-endpoints"></div>
        <div class="heading-text"><div id="removal-of-additional-data-and-pagination-objects-from-3-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>Removal of <code>additional_data</code> and <code>pagination</code> objects from 3 endpoints</div>
        <a aria-label="Skip link to Removal of additional_data and pagination objects from 3 endpoints " class="heading-anchor-icon fa fa-anchor" 
           href="#removal-of-additional-data-and-pagination-objects-from-3-endpoints"></a></h3>
       
      <p><b>What will change?</p></b>

      <p>We have now deprecated and will be removing the <code>additional_data</code> and <code>pagination</code> objects on July 1, 2020 from the responses of the following Deal, Person and Organization endpoints.</p>

  <p><b>Here is the list of 3 affected endpoints:</b></p>
  
     <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#getPersonUsers" target="_self">GET /persons/{id}/permittedUsers</a></code></li> 
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationUsers" target="_self">GET /organizations/{id}/permittedUsers</a></code></li>
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals/Deals#getDealUsers" target="_self">GET /deals/{id}/permittedUsers</a></code></li>
     </ul>
   
 
<p>How the response body currently looks:</p>
 <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar"><button type="button">JSON</button></div><div class="CodeTabs-inner"><pre><code class="rdmd-code lang-json theme-light" data-lang="json" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><div class="cm-s-neo">{
  <span class="cm-property">"success"</span>: <span class="cm-atom">true</span>,
  <span class="cm-property">"data"</span>: [
    <span class="cm-number">007</span>
  ],
  <span class="cm-property">"additional_data"</span>: {
    <span class="cm-property">"pagination"</span>: {
      <span class="cm-property">"start"</span>: <span class="cm-number">0</span>,
      <span class="cm-property">"limit"</span>: <span class="cm-number">1</span>,
      <span class="cm-property">"more_items_in_collection"</span>: <span class="cm-atom">false</span>
    }
  }
}
</div></code></pre></div></div>
      
<p>Response body after the change:</p>
  <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar"><button type="button">JSON</button></div><div class="CodeTabs-inner"><pre><code class="rdmd-code lang-json theme-light" data-lang="json" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><div class="cm-s-neo">{
  <span class="cm-property">"success"</span>: <span class="cm-atom">true</span>,
  <span class="cm-property">"data"</span>: [
    <span class="cm-number">007</span>
  ]
}
</div></code></pre></div></div>
  <p>If your requests to those three endpoints also contain <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination">pagination</a> related parameters <code>limit</code> and <code>start</code> we recommend removing those as they won’t serve their purpose any longer.
</p>
  <p><b>Who is affected?</b><p>
<p>Anyone with functionality built on top of the previous behaviour. For example, anyone who is strictly checking the shape of the response of the aforementioned 3 endpoints.</p>

<p class="published-on"><i>Published on May 25, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API"], "features": ["Deals", "Persons", "Organizations"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 1, 2020</span>
    </div>
     <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="removal-of-additional-data-and-pagination-objects-from-3-endpoints"></div>
        <div class="heading-text"><div id="removal-of-additional-data-and-pagination-objects-from-3-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>Removal of <code>additional_data</code> and <code>pagination</code> objects from 3 endpoints</div>
        <a aria-label="Skip link to Removal of additional_data and pagination objects from 3 endpoints " class="heading-anchor-icon fa fa-anchor" 
           href="#removal-of-additional-data-and-pagination-objects-from-3-endpoints"></a></h3>
       
      <p><b>What will change?</p></b>

      <p>We have now deprecated and will be removing the <code>additional_data</code> and <code>pagination</code> objects on July 1, 2020 from the responses of the following Deal, Person and Organization endpoints.</p>

  <p><b>Here is the list of 3 affected endpoints:</b></p>
  
     <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#getPersonUsers" target="_self">GET /persons/{id}/permittedUsers</a></code></li> 
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationUsers" target="_self">GET /organizations/{id}/permittedUsers</a></code></li>
   <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals/Deals#getDealUsers" target="_self">GET /deals/{id}/permittedUsers</a></code></li>
     </ul>
   
 
<p>How the response body currently looks:</p>
 <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar"><button type="button">JSON</button></div><div class="CodeTabs-inner"><pre><code class="rdmd-code lang-json theme-light" data-lang="json" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><div class="cm-s-neo">{
  <span class="cm-property">"success"</span>: <span class="cm-atom">true</span>,
  <span class="cm-property">"data"</span>: [
    <span class="cm-number">007</span>
  ],
  <span class="cm-property">"additional_data"</span>: {
    <span class="cm-property">"pagination"</span>: {
      <span class="cm-property">"start"</span>: <span class="cm-number">0</span>,
      <span class="cm-property">"limit"</span>: <span class="cm-number">1</span>,
      <span class="cm-property">"more_items_in_collection"</span>: <span class="cm-atom">false</span>
    }
  }
}
</div></code></pre></div></div>
      
<p>Response body after the change:</p>
  <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar"><button type="button">JSON</button></div><div class="CodeTabs-inner"><pre><code class="rdmd-code lang-json theme-light" data-lang="json" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><div class="cm-s-neo">{
  <span class="cm-property">"success"</span>: <span class="cm-atom">true</span>,
  <span class="cm-property">"data"</span>: [
    <span class="cm-number">007</span>
  ]
}
</div></code></pre></div></div>
  <p>If your requests to those three endpoints also contain <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination">pagination</a> related parameters <code>limit</code> and <code>start</code> we recommend removing those as they won’t serve their purpose any longer.
</p>
  <p><b>Who is affected?</b><p>
<p>Anyone with functionality built on top of the previous behaviour. For example, anyone who is strictly checking the shape of the response of the aforementioned 3 endpoints.</p>

<p class="published-on"><i>Published on May 25, 2020</i></p>
    </div>
</div>


Removal of <code>additional_data</code> and <code>pagination</code> objects from 3 endpoints

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">April 23, 2020</span>
    </div>
<div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-scopes-for-goals-and-teams"></div>
        <div class="heading-text"><div id="new-scopes-for-goals-and-teams" class="heading-anchor_backwardsCompatibility">
          </div>New scopes for Goals and Teams </div>
        <a aria-label="Skip link to New scopes for Goals and Teams" class="heading-anchor-icon fa fa-anchor" 
           href="#new-scopes-for-goals-and-teams"></a></h3>

  
      <p><b>Goals</b> help sales teams meet their sales targets and <b>Teams</b> allow sales people to form groups of users within the organization for more efficient management.</p>

<p>To be able to use an endpoint using <a href="https://pipedrive.readme.io/docs/marketplace-oauth-api">OAuth authorization</a>, the endpoint needs to be added to a scope. This is why we have added the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Goals" target="_self">Goals</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Teams" target="_self">Teams</a></code> resources to our scopes.</p>

<p>You can find the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Goals" target="_self">Goals</a></code> resource under <code>goals:read</code> and <code>goals:full</code> scopes, and the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Teams" target="_self">Teams</a></code> resources under <code>users:read</code> and <code>admin</code> scopes.</p>
      
<p>You can read more about the scopes and permission explanations <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">here</a>.</p> 
     <p>If you wish to update the scopes of an already approved or published app, be sure to <a href="https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#section-changing-the-scopes">learn how changing the scopes will affect your existing users</a>.</p>

      
        <p class="published-on"><i>Published on April 23, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">April 23, 2020</span>
    </div>
<div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-scopes-for-goals-and-teams"></div>
        <div class="heading-text"><div id="new-scopes-for-goals-and-teams" class="heading-anchor_backwardsCompatibility">
          </div>New scopes for Goals and Teams </div>
        <a aria-label="Skip link to New scopes for Goals and Teams" class="heading-anchor-icon fa fa-anchor" 
           href="#new-scopes-for-goals-and-teams"></a></h3>

  
      <p><b>Goals</b> help sales teams meet their sales targets and <b>Teams</b> allow sales people to form groups of users within the organization for more efficient management.</p>

<p>To be able to use an endpoint using <a href="https://pipedrive.readme.io/docs/marketplace-oauth-api">OAuth authorization</a>, the endpoint needs to be added to a scope. This is why we have added the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Goals" target="_self">Goals</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Teams" target="_self">Teams</a></code> resources to our scopes.</p>

<p>You can find the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Goals" target="_self">Goals</a></code> resource under <code>goals:read</code> and <code>goals:full</code> scopes, and the endpoints of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Teams" target="_self">Teams</a></code> resources under <code>users:read</code> and <code>admin</code> scopes.</p>
      
<p>You can read more about the scopes and permission explanations <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations">here</a>.</p> 
     <p>If you wish to update the scopes of an already approved or published app, be sure to <a href="https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#section-changing-the-scopes">learn how changing the scopes will affect your existing users</a>.</p>

      
        <p class="published-on"><i>Published on April 23, 2020</i></p>
    </div>
</div>


New scopes for Goals and Teams

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">April 15, 2020</span>
    </div>
 <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-paramteres-added-activities-post-and-put-endpoints"></div>
        <div class="heading-text"><div id="new-paramteres-added-activities-post-and-put-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>New parameters added to <code>/activities</code> <code>POST</code> and <code>PUT</code> endpoints</div>
        <a aria-label="Skip link to New parameters added to /activities POST and PUT endpoints" class="heading-anchor-icon fa fa-anchor" 
           href="#new-paramteres-added-activities-post-and-put-endpoints"></a></h3>

      <p>We have added four new parameters to <code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#addActivity" target="_self">POST /activities</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity" target="_self">PUT /activities/{id}</a></code> endpoints:</p>
   <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left">Parameter</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">location</span></code></td><td style="text-align:left">Allows inserting the address of the activity.</td></tr><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">public_description</span></code></td><td style="text-align:left">Allows adding additional details about the activity that will be synced to your external calendar.</td></tr><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">busy_flag</span></code></td><td style="text-align:left">Allows setting the activity as “busy” or “free”.</td></tr><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">attendees</span></code></td><td style="text-align:left">Allows adding guests to the activity whether it is an existing Pipedrive contact or an external email address.</td></tr></tbody></table></div></div>
 
        <p class="published-on"><i>Published on April 15, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API"], "features": ["Activities"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">April 15, 2020</span>
    </div>
 <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="new-paramteres-added-activities-post-and-put-endpoints"></div>
        <div class="heading-text"><div id="new-paramteres-added-activities-post-and-put-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>New parameters added to <code>/activities</code> <code>POST</code> and <code>PUT</code> endpoints</div>
        <a aria-label="Skip link to New parameters added to /activities POST and PUT endpoints" class="heading-anchor-icon fa fa-anchor" 
           href="#new-paramteres-added-activities-post-and-put-endpoints"></a></h3>

      <p>We have added four new parameters to <code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#addActivity" target="_self">POST /activities</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity" target="_self">PUT /activities/{id}</a></code> endpoints:</p>
   <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left">Parameter</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">location</span></code></td><td style="text-align:left">Allows inserting the address of the activity.</td></tr><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">public_description</span></code></td><td style="text-align:left">Allows adding additional details about the activity that will be synced to your external calendar.</td></tr><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">busy_flag</span></code></td><td style="text-align:left">Allows setting the activity as “busy” or “free”.</td></tr><tr><td style="text-align:left"><code class="rdmd-code lang- theme-light" data-lang="" name=""><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><span class="cm-s-neo">attendees</span></code></td><td style="text-align:left">Allows adding guests to the activity whether it is an existing Pipedrive contact or an external email address.</td></tr></tbody></table></div></div>
 
        <p class="published-on"><i>Published on April 15, 2020</i></p>
    </div>
</div>


New parameters added to <code>/activities POST</code> and <code>PUT</code> endpoints

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 31, 2021</span>
    </div>
   <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="removal-of-the-/find-/searchresults-and-/searchresults/field-endpoints-replaced-by-6-new-endpoints"></div>
        <div class="heading-text"><div id="removal-of-the-/find-/searchresults-and-/searchresults/field-endpoints-replaced-by-6-new-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>Removal of the <code>/*/find</code>, <code>/searchResults</code>, and <code>/searchResults/field</code> endpoints, replaced by 6 new endpoints</div>
        <a aria-label="Skip link to Removal of the /*/find, /searchResults, and /searchResults/field endpoints, replaced by 6 new endpoints" class="heading-anchor-icon fa fa-anchor" 
           href="#removal-of-the-/find-/searchresults-and-/searchresults/field-endpoints-replaced-by-6-new-endpoints"></a></h3>
 
  
       <p><b>What will change?</b></p>
       <p>We have now deprecated and will soon be removing the following 6 API endpoints: </p>
   <ul>
<li><a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDealsByName" target="_self">GET /deals/find</a> - Searches all deals by their title</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/Persons#findPersonByName" target="_self">GET /persons/find</a> - Searches all persons by their name</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationByName" target="_self">GET /organizations/find</a> - Searches all organizations by their name</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/Products#findProductsByName" target="_self">GET /products/find</a> - Returns data about the products that were found.</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/SearchResults#search" target="_self">GET /searchResults</a> - Searches all items or 1 item by all fields</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/SearchResults#searchByField" target="_self">GET /searchResults/field</a> - searches 1 item type by 1 field</li></ul>

<p>We strongly advise you to avoid the use of these 6 <b>deprecated</b> API endpoints.</p>


      
     <p><b> Why?</b></p>
<p>We are introducing 6 new endpoints:</p>
      
 <ul>
<li><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem" target="_self">GET /itemSearch</a></li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField" target="_self">GET /itemSearch/field</a></li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Deals#searchDeals" target="_self">GET /deals/search</a> </li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons" target="_self">GET /persons/search</a> </li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#searchOrganization" target="_self">GET /organizations/search</a> </li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Products#searchProducts" target="_self">GET /products/search</a> </li>
     </ul>


     
<p>The new Search API endpoints offer extended functionality over the old search API and have a unified future-proof response format. The extended functionality allows you to do complicated queries from several item types and fields at once. </p>
      
<p>For example you can use <code>/v1/itemSearch?item_types=deal,person&fields=title,name,custom_fields&term=example</code> to search from all persons and deals by the person’s name, deal title and both items custom fields and order them by relevance.</p>

<p>The <code>/*/search</code> endpoints are aliases for <code>/v1/itemSearch?item_types=*</code> endpoint with narrower OAuth2 scopes for if you are a marketplace app owner and would like your app to only have <code>read</code> access to specific item types instead of the full search scope.</p>

     <p><b> Who is affected?</b></p>
      <p>Anyone depending on the previously listed 6 <b>deprecated</b> endpoints in any way is affected. In case you are using the previously listed 6 <b>deprecated</b> API endpoints in your code or 3rd party app/integration, please remove any dependency on these endpoints as soon as possible, or by <b>March 31, 2021</b> the latest. For additional help, check out <a href="/docs/new-search-api-migration-guide">new search API migration guide</a>. </p>
 
        <p class="published-on"><i>Published on April 8, 2020</i></p>
    </div>
</div>
`}</HTMLBlock>


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 31, 2021</span>
    </div>
   <div class="change-area">
      <h3 class="heading heading-3 header-scroll" align="">
      <div class="heading-anchor anchor waypoint" id="removal-of-the-/find-/searchresults-and-/searchresults/field-endpoints-replaced-by-6-new-endpoints"></div>
        <div class="heading-text"><div id="removal-of-the-/find-/searchresults-and-/searchresults/field-endpoints-replaced-by-6-new-endpoints" class="heading-anchor_backwardsCompatibility">
          </div>Removal of the <code>/*/find</code>, <code>/searchResults</code>, and <code>/searchResults/field</code> endpoints, replaced by 6 new endpoints</div>
        <a aria-label="Skip link to Removal of the /*/find, /searchResults, and /searchResults/field endpoints, replaced by 6 new endpoints" class="heading-anchor-icon fa fa-anchor" 
           href="#removal-of-the-/find-/searchresults-and-/searchresults/field-endpoints-replaced-by-6-new-endpoints"></a></h3>
 
  
       <p><b>What will change?</b></p>
       <p>We have now deprecated and will soon be removing the following 6 API endpoints: </p>
   <ul>
<li><a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDealsByName" target="_self">GET /deals/find</a> - Searches all deals by their title</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/Persons#findPersonByName" target="_self">GET /persons/find</a> - Searches all persons by their name</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationByName" target="_self">GET /organizations/find</a> - Searches all organizations by their name</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/Products#findProductsByName" target="_self">GET /products/find</a> - Returns data about the products that were found.</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/SearchResults#search" target="_self">GET /searchResults</a> - Searches all items or 1 item by all fields</li>
        <li><a href="https://developers.pipedrive.com/docs/api/v1/SearchResults#searchByField" target="_self">GET /searchResults/field</a> - searches 1 item type by 1 field</li></ul>

<p>We strongly advise you to avoid the use of these 6 <b>deprecated</b> API endpoints.</p>


      
     <p><b> Why?</b></p>
<p>We are introducing 6 new endpoints:</p>
      
 <ul>
<li><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem" target="_self">GET /itemSearch</a></li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField" target="_self">GET /itemSearch/field</a></li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Deals#searchDeals" target="_self">GET /deals/search</a> </li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons" target="_self">GET /persons/search</a> </li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#searchOrganization" target="_self">GET /organizations/search</a> </li>
       <li><a href="https://developers.pipedrive.com/docs/api/v1/Products#searchProducts" target="_self">GET /products/search</a> </li>
     </ul>


     
<p>The new Search API endpoints offer extended functionality over the old search API and have a unified future-proof response format. The extended functionality allows you to do complicated queries from several item types and fields at once. </p>
      
<p>For example you can use <code>/v1/itemSearch?item_types=deal,person&fields=title,name,custom_fields&term=example</code> to search from all persons and deals by the person’s name, deal title and both items custom fields and order them by relevance.</p>

<p>The <code>/*/search</code> endpoints are aliases for <code>/v1/itemSearch?item_types=*</code> endpoint with narrower OAuth2 scopes for if you are a marketplace app owner and would like your app to only have <code>read</code> access to specific item types instead of the full search scope.</p>

     <p><b> Who is affected?</b></p>
      <p>Anyone depending on the previously listed 6 <b>deprecated</b> endpoints in any way is affected. In case you are using the previously listed 6 <b>deprecated</b> API endpoints in your code or 3rd party app/integration, please remove any dependency on these endpoints as soon as possible, or by <b>March 31, 2021</b> the latest. For additional help, check out <a href="/docs/new-search-api-migration-guide">new search API migration guide</a>. </p>
 
        <p class="published-on"><i>Published on April 8, 2020</i></p>
    </div>
</div>


Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog