Connecting to Freshsales

Freshsales uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to Freshsales, you'll need to provide your API Key. The API Key for your account can be found under your profile Settings > API Settings, in the top-right corner. Additionally, you will need to set the Domain, found in the domain name of your Freshsales account. For example if your Freshsales portal is acmeinc.myfreshworks.com/crm/sales/my_dashboards, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\Freshsales.apip;ProfileSettings='Domain=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.