Automate Freshteam Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Freshteam data from PowerShell? This article demonstrates how to utilize the Freshteam Cmdlets for tasks like connecting to Freshteam 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 Freshteam.

ADO.NET Provider

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

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

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

Freshteam API Profile Settings

Find your API Key in the top-right corner of your Freshteam account under the API Key section. Your AccountName is the subdomain of your Freshteam 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 Freshteam:

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

    $sql="SELECT Id, Name from Branches"
    
    $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 Freshteam with the API Driver

Connect to Freshteam