Cmdlets for Pipedrive

Build 25.0.9434

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our Pipedrive Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Connecting to Pipedrive

Pipedrive offers two ways to connect and authenticate: Basic and OAuth.

Basic Authentication

To authenticate via Basic authentication:

  1. Obtain an API Token:
    1. Open the Pipedrive portal.
    2. At the top right corner of the page, click the account name. Pipedrive displays a drop-down list.
    3. Navigate to Company Settings > Personal Preferences > API > Generate Token.
    4. Record the value of the generated API token. Also, note the CompanyDomain,which is visible in the PipeDrive HomePage URL. (This is the company's developer sandbox URL.)
  2. Set these connection properties:

  3. Log in with the approved user name and password.

The API Token is stored in the Pipedrive portal. To retrieve it, click the company name, then use the drop-down list to navigate to Company Settings > Personal Preferences > API.

OAuth Authentication

If you do not have access to the user name and password or do not want to require them, use the OAuth user consent flow. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth and create a custom OAuth application.

The following subsections describe how to authenticate to Pipedrive from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Pipedrive, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret that was assigned when you registered your custom OAuth application.
  • CallbackURL: The redirect URI that was defined when you registered your custom OAuth application.

When you connect, the cmdlet opens Pipedrive's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the cmdlet refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the cmdlet automatically refresh the OAuth access token:

  1. Before connecting to data for the first time, set these connection parameters:
  2. On subsequent data connections, set:

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set these connection properties:

    • OAuthClientId: The Client Id in your custom OAuth application settings.
    • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier value.
  • Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

  1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

    Set these properties:

  2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

    Copy this URL and paste it into a new browser tab.

  3. Log in and grant permissions to the cmdlet. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

  4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, to obtain the OAuth authentication values, set these properties:

  5. Test the connection to generate the OAuth settings file.

  6. You are ready to connect after you re-set these properties:

    • InitiateOAuth: REFRESH.
    • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the cmdlet.
    • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

  • InitiateOAuth: REFRESH
  • OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the cmdlet.
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Creating a Connection Object

You can then use the Connect-Pipedrive cmdlet to create a connection object that can be passed to other cmdlets: 

$conn = Connect-Pipedrive -AuthScheme "Basic" -CompanyDomain "MyCompanyDomain" -APIToken "MyAPIToken"

Retrieving Data

The Select-Pipedrive cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-Pipedrive -Connection $conn -Table "Deals" -Columns @("Id, UserEmail") -Where "UserName='Bob'"
The Invoke-Pipedrive cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file: 

Select-Pipedrive -Connection $conn -Table Deals -Where "UserName = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDealsData.csv -NoTypeInformation

You will notice that we piped the results from Select-Pipedrive into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON: 

 
PS C:\> $conn  = Connect-Pipedrive -AuthScheme "Basic" -CompanyDomain "MyCompanyDomain" -APIToken "MyAPIToken"
PS C:\> $row = Select-Pipedrive -Connection $conn -Table "Deals" -Columns (Id, UserEmail) -Where "UserName = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Deals",
  "Columns":  [

  ],
  "Id":  "MyId",
  "UserEmail":  "MyUserEmail"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-Pipedrive -Connection $conn -Table Deals -Where "UserName = 'Bob'" | Remove-Pipedrive

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Pipedrive, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyDealsUpdates.csv | %{
  $record = Select-Pipedrive -Connection $conn -Table Deals -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Pipedrive -Connection $conn -Table Deals -Columns @("Id","UserEmail") -Values @($_.Id, $_.UserEmail) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Pipedrive -Connection $conn -Table Deals -Columns @("Id","UserEmail") -Values @($_.Id, $_.UserEmail)
  }
}

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434