API Data Provider - Online Help

Connecting to Freshservice

Freshservice uses Token authentication to control access to its API.

Using Token Authentication

In order to authenticate to Freshservice, you'll need to provide your API Key. The API Key for your account can be found under your profile Settings, in the top-right corner. Additionally, you will need to set the Domain, found in the domain name of your Freshservice account. For example if your Freshservice portal is acmeinc.freshservice.com, 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\Freshservice.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.


Property Description
APIKey Your Freshservice API Key.
Domain Your helpdesk domain name.

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