How to pipe Zenefits Data to CSV in PowerShell

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

Creating a Connection to Your Zenefits Data

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

Zenefits API Profile Settings

In order to authenticate to Zenefits, you'll need to provide your API Key. To create an API Key, from your account head over to Company Overview > Custom Integrations, then besides Rest API Access select Add Token. Set the API Key in the ProfileSettings property to connect.

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

Selecting Data

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

Select-API -Connection $conn -Table People | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myPeopleData.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.