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

# Freshchat

> How to set up the Freshchat connector, plus the actions that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/freshdesk/filled/svg" alt="Freshchat" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-preview connector-page-stage-tag">Preview</span><span>v0.1.0</span></div>
    <div><a href="/connectors/freshchat/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">14 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">IAM</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/freshchat/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/freshdesk/filled/svg" horizontal>
        Uses the account's Freshchat API key, which an account admin generates. The key reads the whole account, so no per-user...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

    See the guide for the authentication type chosen in the Connector Profile:

    <Columns cols={2}>
      <Card title="Link Account · API Key" href="/connectors/freshchat/guides/link-account/api-key" icon="https://stackone-logos.com/api/freshdesk/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>14 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_get_account_configuration" data-action-label="Get Account Configuration" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Account Configuration</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_get_account_configuration" aria-label="Copy freshchat_get_account_configuration"><code className="connector-page-code">freshchat\_get\_account\_configuration</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the Freshchat account's configuration.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_list_agents" data-action-label="List Agents" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Agents</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_list_agents" aria-label="Copy freshchat_list_agents"><code className="connector-page-code">freshchat\_list\_agents</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List agents in the Freshchat account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_get_agent" data-action-label="Get Agent" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Agent</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_get_agent" aria-label="Copy freshchat_get_agent"><code className="connector-page-code">freshchat\_get\_agent</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a single Freshchat agent by ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_list_groups" data-action-label="List Groups" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Groups</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_list_groups" aria-label="Copy freshchat_list_groups"><code className="connector-page-code">freshchat\_list\_groups</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List groups in the Freshchat account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_get_me" data-action-label="Get Unified Credentials" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Unified Credentials</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_get_me" aria-label="Copy freshchat_unified_get_me"><code className="connector-page-code">freshchat\_unified\_get\_me</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the current Freshchat connection's unified credentials and identity.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_list_groups" data-action-label="List Unified Groups" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Unified Groups</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_list_groups" aria-label="Copy freshchat_unified_list_groups"><code className="connector-page-code">freshchat\_unified\_list\_groups</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List unified groups in a Freshchat account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_get_group" data-action-label="Get Unified Group" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Unified Group</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_get_group" aria-label="Copy freshchat_unified_get_group"><code className="connector-page-code">freshchat\_unified\_get\_group</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a unified Freshchat group by ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_list_organizations" data-action-label="List Unified Organizations" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Unified Organizations</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_list_organizations" aria-label="Copy freshchat_unified_list_organizations"><code className="connector-page-code">freshchat\_unified\_list\_organizations</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List unified organizations in a Freshchat account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_get_organization" data-action-label="Get Unified Organization" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Unified Organization</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_get_organization" aria-label="Copy freshchat_unified_get_organization"><code className="connector-page-code">freshchat\_unified\_get\_organization</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a unified Freshchat organization by ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_list_roles" data-action-label="List Unified Roles" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Unified Roles</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_list_roles" aria-label="Copy freshchat_unified_list_roles"><code className="connector-page-code">freshchat\_unified\_list\_roles</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List unified roles in a Freshchat account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_get_role" data-action-label="Get Unified Role" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Unified Role</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_get_role" aria-label="Copy freshchat_unified_get_role"><code className="connector-page-code">freshchat\_unified\_get\_role</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a unified Freshchat role by ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_list_users" data-action-label="List Unified Users" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Unified Users</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_list_users" aria-label="Copy freshchat_unified_list_users"><code className="connector-page-code">freshchat\_unified\_list\_users</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List unified users in a Freshchat account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_unified_get_user" data-action-label="Get Unified User" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Unified User</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_unified_get_user" aria-label="Copy freshchat_unified_get_user"><code className="connector-page-code">freshchat\_unified\_get\_user</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a unified Freshchat user by ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="freshchat_list_roles" data-action-label="List Roles" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Roles</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="freshchat_list_roles" aria-label="Copy freshchat_list_roles"><code className="connector-page-code">freshchat\_list\_roles</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List roles in the Freshchat account.</div>
      </div>
    </div>
  </div>
</div>