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.
Required Connection Properties
- APIKey: Set this in ProfileSettings to your Freshservice API Key (required).
- Domain: Set this in ProfileSettings to the subdomain of your Freshservice account, e.g. 'acmeinc' for acmeinc.freshservice.com (required).
Example connection string
Profile=C:\profiles\Freshservice.apip;ProfileSettings='Domain=acmeinc;APIKey=my_api_key';
Available Tables
The Freshservice API Profile provides access to the following tables:
- Agents: Lists all agents (support staff) in the account.
- AgentGroups: Lists all agent groups in the account.
- AgentRoles: Lists all agent roles in the account.
- Approvals: Lists all approvals. Requires filtering by Parent and one of ApproverId, StatusName, ParentId, or DelegateeId.
- AssetComponents: Lists all components for a given asset.
- AssetTypes: Lists all asset types in the account.
- Assets: Lists all assets in the account.
- ITAMAssets: Lists all assets using the newer Freshservice IT Asset Management (ITAM) API. Available only for accounts created after the March 31, 2026 release.
- ChangeDetails: Retrieves a single change by ID.
- ChangeNotes: Lists all notes on a given change.
- ChangeTasks: Lists all tasks on a given change.
- ChangeTimeEntries: Lists all time entries logged on a given change.
- Changes: Lists changes created within the past 30 days by default. Use the UpdatedSince filter for older changes.
- Contracts: Lists all contracts in the account.
- Conversations: Lists all conversations on a given ticket.
- Departments: Lists all departments in the account.
- EmployeeOffboardingFormFields: Lists the fields on the employee offboarding form.
- EmployeeOffboardingRequests: Lists all employee offboarding requests.
- EmployeeOffboardingTickets: Lists the tickets associated with a given offboarding request.
- EmployeeOnboardingFormFields: Lists the fields on the employee onboarding form.
- EmployeeOnboardingRequests: Lists all employee onboarding requests.
- EmployeeOnboardingTickets: Lists the tickets associated with a given onboarding request.
- Locations: Lists all locations in the account.
- ProblemDetails: Retrieves a single problem by ID.
- ProblemNotes: Lists all notes on a given problem.
- ProblemTasks: Lists all tasks on a given problem.
- ProblemTimeEntries: Lists all time entries logged on a given problem.
- Problems: Lists all problems in the account.
- Products: Lists all products in the account.
- PurchaseOrders: Lists all purchase orders in the account.
- RequesterFields: Lists all requester fields.
- RequesterGroupMembers: Lists all members of a given requester group.
- RequesterGroups: Lists all requester groups in the account.
- Requesters: Lists all requesters (end users), including agents.
- ServiceCatalogItems: Lists all service catalog items in the account.
- Software: Lists all software applications tracked in the account.
- TicketFields: Lists all ticket fields.
- Tickets: Lists all tickets in the account.
- Vendors: Lists all vendors in the account.
- Workspaces: Lists all workspaces in the account.
Usage Examples
Agents:
SELECT * FROM Agents
AgentGroups:
SELECT * FROM AgentGroups
AgentRoles:
SELECT * FROM AgentRoles
Approvals:
SELECT * FROM Approvals WHERE Parent = 'ticket' AND ParentId = 11
AssetComponents:
SELECT * FROM AssetComponents WHERE AssetDisplayId = 8
AssetTypes:
SELECT * FROM AssetTypes
Assets:
SELECT * FROM Assets SELECT * FROM Assets WHERE DisplayId = 8
ITAMAssets:
SELECT * FROM ITAMAssets SELECT * FROM ITAMAssets WHERE AssetId = 8
ChangeDetails:
SELECT * FROM ChangeDetails WHERE ChangeId = 123
ChangeNotes:
SELECT * FROM ChangeNotes WHERE ChangeId = 123
ChangeTasks:
SELECT * FROM ChangeTasks WHERE ChangeId = 123
ChangeTimeEntries:
SELECT * FROM ChangeTimeEntries WHERE ChangeId = 123
Changes:
SELECT * FROM Changes SELECT * FROM Changes WHERE UpdatedSince = '2024-01-01T00:00:00Z'
Contracts:
SELECT * FROM Contracts
Conversations:
SELECT * FROM Conversations WHERE TicketId = 123
Departments:
SELECT * FROM Departments
EmployeeOffboardingFormFields:
SELECT * FROM EmployeeOffboardingFormFields
EmployeeOffboardingRequests:
SELECT * FROM EmployeeOffboardingRequests
EmployeeOffboardingTickets:
SELECT * FROM EmployeeOffboardingTickets WHERE RequestId = '123'
EmployeeOnboardingFormFields:
SELECT * FROM EmployeeOnboardingFormFields
EmployeeOnboardingRequests:
SELECT * FROM EmployeeOnboardingRequests
EmployeeOnboardingTickets:
SELECT * FROM EmployeeOnboardingTickets WHERE RequestId = '123'
Locations:
SELECT * FROM Locations
ProblemDetails:
SELECT * FROM ProblemDetails WHERE ProblemId = 123
ProblemNotes:
SELECT * FROM ProblemNotes WHERE ProblemId = 123
ProblemTasks:
SELECT * FROM ProblemTasks WHERE ProblemId = 123
ProblemTimeEntries:
SELECT * FROM ProblemTimeEntries WHERE ProblemId = 123
Problems:
SELECT * FROM Problems
Products:
SELECT * FROM Products
PurchaseOrders:
SELECT * FROM PurchaseOrders
RequesterFields:
SELECT * FROM RequesterFields
RequesterGroupMembers:
SELECT * FROM RequesterGroupMembers WHERE RequesterGroupId = 123
RequesterGroups:
SELECT * FROM RequesterGroups
Requesters:
SELECT * FROM Requesters
ServiceCatalogItems:
SELECT * FROM ServiceCatalogItems SELECT * FROM ServiceCatalogItems WHERE DisplayId = 8
Software:
SELECT * FROM Software
TicketFields:
SELECT * FROM TicketFields
Tickets:
SELECT * FROM Tickets
Vendors:
SELECT * FROM Vendors
Workspaces:
SELECT * FROM Workspaces
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. |
| AuthScheme | The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD |
| Domain | Your helpdesk domain name. |