How to pipe ClickUp Data to CSV in PowerShell

The CData Cmdlets Module for ClickUp is a standard PowerShell module offering straightforward integration with ClickUp. Below, you will find examples of using our API Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your ClickUp Data

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

ClickUp API Profile Settings

In order to authenticate to ClickUp, you'll need to provide your API Key. You can find this token in your user settings, under the Apps section. At the top of the page you have the option to generate a personal token. Set the API Key to your personal token in the ProfileSettings property to connect.

$conn = Connect-API -Profile "$Profile" -ProfileSettings "$ProfileSettings"

Selecting Data

Follow the steps below to retrieve data from the Tasks table and pipe the result into to a CSV file:

Select-API -Connection $conn -Table Tasks | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTasksData.csv -NoTypeInformation

You will notice that we piped the results from Select-API 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" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.