Automate Freshsales Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Freshsales data from PowerShell? This article demonstrates how to utilize the Freshsales Cmdlets for tasks like connecting to Freshsales data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Freshsales.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Freshsales; this tutorial shows how to use the Provider to retrieve Freshsales data.

Once you have acquired the necessary connection properties, accessing Freshsales data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the Freshsales Profile on disk (e.g. C:\profiles\Freshsales.apip). Next, set the ProfileSettings connection property to the connection string for Freshsales (see below).

Freshsales API Profile Settings

Retrieve your API Key from Profile Settings > API Settings in the top-right corner of Freshsales. Your Domain is the subdomain from your portal URL.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to Freshsales:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Freshsales.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Name from Account"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.id $_.name
    }
      

Ready to get started?

Connect to live data from Freshsales with the API Driver

Connect to Freshsales