API Data Provider - Online Help

Connecting to Freshteam

Freshteam uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to Freshteam, you'll need to provide your API Key. The API Key for your account can be found under the top-right corner, at API Key section . Additionally, you will need to set the AccountName, found in the url of your Freshteam account. For example if your Freshteam account is acmeinc.freshteam.com, then the AccountName should be 'acmeinc'. Set both the API Key and AccountName in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\Freshteam.apip;ProfileSettings='AccountName=acmeinc;APIKey=my_api_key';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
AccountName The AccountName for the Freshteam account.
APIKey Your Freshteam API Key.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060.0