New parameter in OAuth /oauth/token responses

What will change?

We have added a new parameter api_domain to OAuth /oauth/token responses.

For now, only the apps created on or after February 20, 2020 will see a new parameter in the OAuth /oauth/token response.

On June 1, 2020, the code will automatically start sending the new parameter to all requests, i.e. apps created before February 20, 2020 will also start seeing the new parameter in the OAuth /oauth/token response. If you are strictly checking the shape of the response, please update your code to take the new parameter into account.

Why?

Until now (and because we ask you to use https://companydomain.pipedrive.com domains for making API requests), in order to find out the company_domain, you had to get the OAuth tokens first, make a request to /users/me endpoint and store it on your side. Also, the company_domain can change so you had to make additional request to /users/me every once in a while.

But with this change you do not have to do that anymore, because you will now receive up-to-date company_domain every time you make the initial request to get the tokens or when you refresh a token.

The current response:

{
    "access_token": "53:179:6317ef33a9fb0c4d604ce0695dad44a12bad44c9",
    "token_type": "Bearer",
    "expires_in": 3599,
    "refresh_token": "53:179:5de81994d77491d22bc10eab3bc0810f84864297",
    "scope": "base,deals:full,contacts:read"
}

The new response with the added api_domain parameter:

{
    "access_token": "53:179:6317ef33a9fb0c4d604ce0695dad44a12bad44c9",
    "token_type": "Bearer",
    "expires_in": 3599,
    "refresh_token": "53:179:5de81994d77491d22bc10eab3bc0810f84864297",
    "scope": "base,deals:full,contacts:read",
    "api_domain": "https://mycompanydomain.pipedrive.com"
}

Who is affected?

Any app created before February 20, 2020 with functionality built on top of the previous behavior need to alter their code by June 1, 2020.

Any apps created on or after February 20, 2020 will already see the new parameter in the OAuth /oauth/token/ response and do not need to alter anything concerning this change.

Published on February 21, 2020