[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">October 31, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>1. We have corrected the documentation of <code>Content-Type</code> for body parameters from <code>application/x-www-form-urlencoded</code> to <code>application/json</code> to reflect reality for the following ActivityTypes endpoints: </p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ActivityTypes#addActivityType\">POST /activityTypes</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ActivityTypes#updateActivityType\">PUT /activityTypes/{id}</a></code></li>\n      </ul>\n      \n      <p>2. The <code>related_objects</code> section of the response example now includes <code>stage</code> and <code>pipeline</code> information to reflect reality for the following endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\">GET /deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeal\">GET /deals/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationDeals\">GET /organizations/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonDeals\">GET /persons/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductDeals\">GET /products/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\">POST /deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\">PUT /deals/{id}</a></code></li>\n      </ul>\n      \n    </div>\n</div>"
}
[/block]

The latest improvements to our API Reference include a Content-Type update for ActivityTypes endpoints and documented stage and pipeline information in the response examples of Deals-related endpoints.

October 2022 release notes

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">December 16, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p><b>What is changing?</b></p>\n      <p>From <b>December 16, 2022</b>, the <code>type.params.pipeline_id</code> \n        and <code>type.params.activity_type_id</code> query parameters will only \n        accept the specified IDs as an <b>array</b> for the \n        <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#getGoals\">GET /goals/find</a></code> endpoint.</p>\n      \n      <p>Similarly, the <code>pipeline_id</code> and <code>activity_type_id</code>\n        response fields will be returned as an <b>array</b> in the following \n        endpoints’ responses:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#getGoals\">GET /goals/find</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#getGoalResult\">GET /goals/{id}/results</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#addGoal\">POST /goals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#updateGoal\">PUT /goals/{id}</a></code></li>\n      </ul>\n      \n      <p><b>Why is it changing?</b></p>\n      <p>Due to a legacy implementation on our side, the \n        <code>type.params.pipeline_id</code> and \n        <code>type.params.activity_type_id</code> query parameters have so far \n        accepted both integer and array data types. From December 16, 2022, \n        they will accept and return an array to support the inclusion of \n        multiple pipelines and/or activity types for your goals.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone using the specified query parameters to find goals and/or strictly checking the response structure of these endpoints.</p>\n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n    \n  </div>\n</div>"
}
[/block]

The type.params.pipeline_id and type.params.activity_type_id query parameters will only accept the specified IDs as an array for the GET /goals/find endpoint. Additionally, these parameters will be returned as arrays in the responses of Goals API endpoints.

Breaking change in Goals API <code>pipeline_id</code> and <code>activity_type_id</code> data types

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">December 5, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p><b>What is changing?</b></p>\n      <p>We have deprecated and will remove the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#getRoleSubRoles\">GET /roles/{id}/roles</a></code> endpoint from the Roles API on <b>December 5, 2022</b>.</p>\n      <p>We strongly advise you to avoid using the deprecated endpoint.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone who is using the deprecated <code>GET</code> endpoint for retrieving the sub-roles of a role.</p>\n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n    \n    \n  </div>\n</div>"
}
[/block]

We have deprecated and will remove the GET /roles/{id}/roles endpoint from the Roles API.

Removal of the <code>GET /roles/{id}/roles</code> endpoint

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">September 29, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p>1. We have corrected the documentation of Content-Type for body parameters from <code>application/x-www-form-urlencoded</code> to <code>application/json</code> to reflect reality for the following Goals, Roles and Users API endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#updateGoal\">PUT /goals/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addRole\">POST /roles</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addRoleAssignment\">POST /roles/{id}/assignments </a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addOrUpdateRoleSetting\">POST /roles/{id}/settings</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#updateRole\">PUT /roles/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#deleteRoleAssignment\">DELETE /roles/{id}/assignments</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\">PUT /users/{id}</a></code></li>\n      </ul>\n      \n      <p>2. The <code>name</code> body parameter was labeled as <code>required</code> to reflect reality for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addRole\">POST /roles</a></code> endpoint.</p>\n    \n  </div>\n</div>"
}
[/block]

The latest changes to our API Reference include: updated Content-Type for Goals, Roles and Users API body parameters and removed the required label from POST /roles name parameter.

September 2022 release notes

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">November 4, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p><b>What is changing?</b></p> \n      <p>All values of the <code>date</code> type inside a filter’s conditions have to adhere to the <code>YYYY-MM-DD</code> date format.</p>\n      <p>This update applies to the following Filters API endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#addFilter\">POST /filters</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter\">PUT /filters/{id}</a></code></li>\n      </ul>\n      \n      <p>If an invalid <code>date</code> format is included in the condition(s), the request will return a <code>400</code> error response.</p>\n      \n      <p>Here’s an example for filtering deals by their expected close date:</p>\n      <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\">{\n    <span class=\"cm-property\">\"name\"</span>: <span class=\"cm-string\">\"Filter by expected close date\"</span>,\n    <span class=\"cm-property\">\"type\"</span>: <span class=\"cm-string\">\"deals\"</span>,\n    <span class=\"cm-property\">\"conditions\"</span>: {\n        <span class=\"cm-property\">\"glue\"</span>: <span class=\"cm-string\">\"and\"</span>,\n        <span class=\"cm-property\">\"conditions\"</span>: [{\n            <span class=\"cm-property\">\"glue\"</span>: <span class=\"cm-string\">\"and\"</span>,\n            <span class=\"cm-property\">\"conditions\"</span>: [{\n                <span class=\"cm-property\">\"object\"</span>: <span class=\"cm-string\">\"deal\"</span>,\n                <span class=\"cm-property\">\"field_id\"</span>: <span class=\"cm-string\">\"12345\"</span>,\n                <span class=\"cm-property\">\"operator\"</span>: <span class=\"cm-string\">\"&lt;=\"</span>,\n                <span class=\"cm-property\">\"value\"</span>: <span class=\"cm-string\">\"2022-09-05\"</span>,\n                <span class=\"cm-property\">\"extra_value\"</span>: <span class=\"cm-atom\">null</span>\n            }]\n        }, {\n            <span class=\"cm-property\">\"glue\"</span>: <span class=\"cm-string\">\"or\"</span>,\n            <span class=\"cm-property\">\"conditions\"</span>: []\n        }]\n    }\n}\n</div></code></pre></div></div>\n      \n     \n      <p><b>Why is it changing?</b></p> \n      <p>The <code>YYYY-MM-DD</code> date format will be applied to make sure \n        that the Filters API is consistent with the Pipedrive web app. \n        This ensures that the filters you create with date conditions work \n        as expected and return the correct results.</p>\n      \n      <p><b>Who will be affected?</b></p> \n      <p>Everyone who is using the <code>POST</code> and <code>PUT</code> endpoints \n        for adding filters.</p>\n      \n      <p>If you have any questions or comments, let us know in \n        the <a href=\"https://devcommunity.pipedrive.com/\">Developer’s Community</a>.</p>\n     \n   </div>\n</div>"
}
[/block]

All date type values inside a filter’s conditions will have to adhere to the YYYY-MM-DD date format. The update will apply to the POST /filters and PUT /filters/{id} endpoints.

Breaking change in Filters API <code>date</code> value

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 31, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p>1. The <code>required</code> label has been removed from the body parameters of the following endpoints to reflect reality:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\">POST /users</a></code>: <code>active_flag</code> is not required</li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\">PUT /organizations/{id}</a></code>: <code>name</code> is not required</li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#updateNote\">PUT /notes/{id}</a></code>: <code>content</code> is not required</li>\n      </ul>\n      \n      <p>2. Apps can now access the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#getFilterHelpers\">GET /filters/helpers</a></code> endpoint with the following <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\">OAuth scopes</a>:</p>\n      <ul>\n        <li><code>deals:read</code></li>\n        <li><code>deals:full</code></li>\n        <li><code>activities:read</code></li>\n        <li><code>activities:full</code></li>\n        <li><code>contacts:read</code></li>\n        <li><code>contacts:full</code></li>\n      </ul>\n     \n  </div>\n</div>"
}
[/block]

The latest update to our developer platform includes additional OAuth scopes for the GET /filters/helpers endpoint.

August 2022 release notes

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 10, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p><b>What is being added?</b></p>\n      <p><a href=\"https://jwt.io/\">JSON web token</a> (JWT) capability has been added to <a href=\"https://pipedrive.readme.io/docs/app-extensions-actions\">Link actions</a> (formerly basic app actions) and <a href=\"https://pipedrive.readme.io/docs/app-extensions-json-panels\">JSON panels</a> (formerly app panels) app extensions.</p>\n      <p>For JSON panels, you now have a choice to use either <a href=\"https://pipedrive.readme.io/docs/json-panels-adding-a-panel#how-can-i-add-a-json-panel-in-marketplace-manager\">Basic Authentication</a> or JWT. It is also possible to configure both.</p>  \n    \n      <p><b>Why is it being added?</b></p>\n      <p>JWT adds a layer of security and more flexibility on top of Link actions initiated from Pipedrive and requests sent from a JSON panel to a 3rd party server. It also provides a more versatile authentication option for JSON panel requests.</p>\n      <p>This addition means JWT is now available uniformly across all our app extension requests.</p>\n\n      <p><b>Who is affected?</b></p>\n      <p>Anyone who is building an app or has an app that uses Link actions and JSON panels app extensions.</p>\n   \n  </div>\n</div>"
}
[/block]

JSON web token (JWT) capability has now been added to Link actions and JSON panels app extensions.

Addition of JWT capability for Link actions and JSON panels

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 9, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>We have made a few updates to the <a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets\" target=\"_self\">PermissionSets API</a> to support <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_self\">global user management</a> and app-specific permission sets:</p>\n      <ol>\n        <li>A new optional query parameter <code>app</code> has been added to the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets\" target=\"_self\">GET /permissionSets</a></code> endpoint:</li>\n        \t<ul>\n            <li><code>app</code> - for filtering permission sets by type (<code>deals</code>, <code>projects</code>, <code>campaigns</code>, <code>global</code>, and <code>account_settings</code>)</li>\n       \t\t </ul>\n        <p></p>\n        \n        <li>The 3 following response fields have been added to the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets\" target=\"_self\">GET /permissionSets</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet\" target=\"_self\">GET /permissionSets/{id}</a></code> endpoints:</li>\n     \t\t\t<ul>\n            <li><code>app</code>  - describes the type of the permission set</li>\n            <li><code>description</code>  - contains the description for the permission set</li>\n            <li><code>type</code> - contains the type of the permission set (<code>admin</code>, <code>manager</code>, <code>regular</code>, or <code>custom</code>)</li>\n        </ul>\n        \n      </ol>\n      \n      <p>And the following updates to the <a href=\"https://developers.pipedrive.com/docs/api/v1/Users\" target=\"_self\">Users API</a>:</p>\n      <ol>\n        <li>A new optional body parameter <code>access</code> has been added to the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"_self\">POST /users</a></code> endpoint to assign access rights for the user.</li>\n        <p></p>\n        <li>A new response field <code>access</code> has been added to six endpoints, including:</li>\n        <ul>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUsers\" target=\"_self\">GET /users</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#findUsersByName\" target=\"_self\">GET /users/find</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getCurrentUser\" target=\"_self\">GET /users/me</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUser\" target=\"_self\">GET /users/{id}</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"_self\">POST /users</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\" target=\"_self\">PUT /users/{id}</a></code></li>\n        </ul>\n        \n        <p></p>\n        <p>The <code>access</code> response field contains information about the user’s admin status, the permission sets assigned to the user, and the permission set IDs.</p>\n      </ol>\n      \n      <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-variable\">“access”</span>: [ \n   {\n      <span class=\"cm-property\">\"app\"</span>: <span class=\"cm-string\">\"sales\"</span>,\n      <span class=\"cm-property\">\"admin\"</span>: <span class=\"cm-atom\">false</span>,\n      <span class=\"cm-property\">\"permission_set_id\"</span>: <span class=\"cm-string\">\"f07d229d-088a-4144-a40f-1fe64295d180\"</span>\n   },\n   {\n      <span class=\"cm-property\">\"app\"</span>: <span class=\"cm-string\">\"global\"</span>,\n      <span class=\"cm-property\">\"admin\"</span>: <span class=\"cm-atom\">true</span>,\n      <span class=\"cm-property\">\"permission_set_id\"</span>: <span class=\"cm-string\">\"233b7976-39bd-43a9-b305-ef3a2b0998e5\"</span>\n   }\n]\n</div></code></pre></div></div>\n      \n  </div>\n</div>"
}
[/block]

We have made a few updates to the PermissionSets and Users API to support global user management and app-specific permission sets.

Improvements to PermissionSets API and Users API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">February 9, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>We have now deprecated and will be removing three response fields and a body parameter from the Users API to adhere to the <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_self\">global user management model</a>.</p>\n      <p>The change is related to the <a href=\"https://developers.pipedrive.com/changelog/post/improvements-to-permissionsets-api-and-users-api\" target=\"_self\">Improvements to PermissionSets API and Users API</a> and the <a href=\"https://developers.pipedrive.com/changelog/post/removal-of-the-codeis_admincode-response-field-from-users-api\" target=\"_self\">Removal of the <code>is_admin</code> response field from Users API</a> announcements.</p>\n      \n      <p><b>What is changing?</b></p> \n      <ol>\n        <li>We have deprecated and will soon be removing the following response fields from six endpoints of the <a href=\"https://developers.pipedrive.com/docs/api/v1/Users\" target=\"_self\">Users API</a>:</li>\n        <ul>\n          <li><code>signup_flow_variation</code></li>\n          <li><code>modified</code>: This field will be included in the response only if the user associated with the request has <a href=\"https://support.pipedrive.com/en/article/user-types-in-pipedrive-account-settings\" target=\"_self\">account settings access</a>.</li>\n          <li><code>phone</code>: This field will be removed for all users, except for the phone number owner. </li>\n          <p></p>\n          <p>The user associated with the request can only see their own phone number in the response, but not other users’ phone numbers, regardless of the user’s access level.</p>\n          \n          <p>Affected endpoints:</p>\n          <ul>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUsers\" target=\"_self\">GET /users</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#findUsersByName\" target=\"_self\">GET /users/find</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getCurrentUser\" target=\"_self\">GET /users/me</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUser\" target=\"_self\">GET /users/{id}</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"_self\">POST /users</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\" target=\"_self\">PUT /users/{id}</a></code></li>\n        </ul>\n        </ul>\n        <p></p>\n        \n        <li>From the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"_self\">POST /users</a></code> endpoint, we have deprecated the <code>name</code> body parameter and it has now been made optional. </li>\n        <p></p>\n        <p>As an alternative to providing a name with the request, the user’s name can initially be filled by the provided e-mail address. The user can specify the name themselves when they accept their e-mail invitation to Pipedrive.</p>\n      </ol>\n      \n      <p><b>We strongly advise you to avoid using these deprecated fields as they will be removed on February 9, 2023.</b></p>\n      \n    <p><b>Why is it changing?</b></p> \n      <p>We are introducing the granularity of user access rights under 5 specific categories: Deals app, Projects app, Campaigns app, Global Permissions, and Account Settings. Each category has its own permission set where you can grant users either the admin or regular access level.</p>\n      <p>We are removing the response fields and body parameter, because they either do not serve their purpose any more or they do not accommodate the new access model. The change aims to ensure consistency between the Pipedrive API and web app as well as increase the user’s privacy control opportunities.</p>\n      \n    <p><b>Who will be affected?</b></p> \n      <p>Everyone who is using the fields mentioned above.</p>\n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developer’s Community</a>.</p>\n \n  </div>\n</div>"
}
[/block]

We have deprecated and will be removing three response fields and a body parameter from the Users API.

Removal of fields from Users API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 9, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>We have now deprecated and will be removing the <code>is_admin</code> response field from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Users\" target=\"_self\">Users API</a> to accommodate <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_self\">global user management</a>.</p>\n      \n      <p>The change is related to the <a href=\"https://developers.pipedrive.com/changelog/post/improvements-to-permissionsets-api-and-users-api\" target=\"_self\">Improvements to PermissionSets API and Users API</a> and the <a href=\"https://developers.pipedrive.com/changelog/post/removal-of-fields-from-users-api\" target=\"_self\">Removal of fields from Users API</a> announcements.</p>\n      \n      <p><b>What is changing?</b></p>\n      <p>We have deprecated the <code>is_admin</code> response field from six endpoints of the Users API, including:</p>\n      <ul>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUsers\" target=\"_self\">GET /users</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#findUsersByName\" target=\"_self\">GET /users/find</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getCurrentUser\" target=\"_self\">GET /users/me</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUser\" target=\"_self\">GET /users/{id}</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"_self\">POST /users</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\" target=\"_self\">PUT /users/{id}</a></code></li>\n        </ul>\n      <p>The response field will be removed in a year - on <b>August 9, 2023</b>.</p>\n      \n      <p>As mentioned in the <a href=\"https://developers.pipedrive.com/changelog/post/improvements-to-permissionsets-api-and-users-api\" target=\"_self\">Improvements to PermissionSets API and Users API</a> announcement, we have added a new <code>access</code> response field to Users API. We recommend using the <code>access</code> field instead, as it includes information about the user’s admin status, the permission sets assigned to the user and the permission set IDs.</p>\n      \n      \n      <p><b>Why is it changing?</b></p>\n      <p>The <code>is_admin</code> response field describes whether the user is an admin, but does not contain information about the user’s permission sets. In order to take full advantage of the new app-specific user access model, the <code>access</code> response field has been implemented and should be used instead.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone who is using the <code>is_admin</code> response field to determine whether the user is an admin.</p>\n      <p>Let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developer’s Community</a> if you have any questions or comments.</p>\n      \n  </div>\n</div>"
}
[/block]

We have now deprecated and will be removing the is_admin response field from Users API.

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog