> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshservice Connector

[Back to the list of Connectors](https://koreai.mintlify.site/agent-platform/knowledge.md#connectors)

The Freshservice connector allows ingestion and indexing of solution articles from your Freshservice account, enabling seamless search across your IT service knowledge base.

## Specifications

| Specifications | Details |
| - | - |
| Supported content | Knowledgebase articles |
| Permission-aware ACL support | Yes |
| Content filtering | Yes |

## Prerequisites

Ensure that:

* You have access to the Freshservice account you want to index.
* Generate the [API key for the Freshservice account](https://support.freshservice.com/support/solutions/articles/50000000306-where-do-i-find-my-api-key-).

## Connector configuration

Provide the following details to configure the Freshservice connector:

| Field | Description |
| - | - |
| Freshservice URL | The URL of your Freshservice account (e.g., `https://yourcompany.freshservice.com`). |
| Freshservice API Key profile | Create an auth profile. Use the the API key for your Freshservice account. |

This loads the available workspaces from the account.

## Choose Solution Scope

Choose the Freshservice workspaces, categories, and folders to sync. Leave a level unselected to include everything at that level.

| Field | Description |
| - | - |
| Workspaces | Select the workspaces to sync. All available workspaces are listed. |
| Categories | Click **Discover categories** to see the list of available categories across selected workspaces. Select the categories to sync. |
| Folders | Click Discover Folders to see the available folders under selected categories in selected workspaces.  Select the folders to sync. |
| Include Subfolders | Select this option to include all subfolders under the selected folders. |
| Enforce Freshservice folder visibility | Select this option to enforce Freshservice folder visibility restrictions applicable at the account level. When enabled, only articles in folders visible to the user associated with the API key will be synchronized. |

Review the proposal, and activate the connector.

After successful activation, use Sync options (full/delta) to ingest and index content from the Freshservice account.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.