Automate ConvertKit Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

ConvertKit API Profile Settings

Navigate to Account Settings > Advanced > API in your ConvertKit account to find both your API Key and API Secret.

  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 ConvertKit:

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

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

Ready to get started?

Connect to live data from ConvertKit with the API Driver

Connect to ConvertKit