> ## 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.

# hc1

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

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/hc1/filled/svg" alt="hc1" 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/hc1/changelog">See changelog</a></div>
  </div>

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

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">CRM</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 · Username and Password" href="/connectors/hc1/guides/connector-profile/username-and-password" icon="https://stackone-logos.com/api/hc1/filled/svg" horizontal>
        Signs in as an hc1 user and acts with that user's role. The user must not have multi-factor authentication turned on.
      </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 · Username and Password" href="/connectors/hc1/guides/link-account/username-and-password" icon="https://stackone-logos.com/api/hc1/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>19 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="hc1_get_session" data-action-label="Get Session" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Session</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_session" aria-label="Copy hc1_get_session"><code className="connector-page-code">hc1\_get\_session</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the signed-in user, tenant, permissions and record type catalog.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_get_my_account" data-action-label="Get My Account" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get My Account</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_my_account" aria-label="Copy hc1_get_my_account"><code className="connector-page-code">hc1\_get\_my\_account</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the signed-in user's account, roles and access.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_user_apps" data-action-label="List User Apps" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List User Apps</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_user_apps" aria-label="Copy hc1_list_user_apps"><code className="connector-page-code">hc1\_list\_user\_apps</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the hc1 applications the signed-in user can open.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_get_realm" data-action-label="Get Realm" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Realm</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_realm" aria-label="Copy hc1_get_realm"><code className="connector-page-code">hc1\_get\_realm</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the configuration of the connected hc1 realm (tenant).</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_dashboards" data-action-label="List Dashboards" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Dashboards</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_dashboards" aria-label="Copy hc1_list_dashboards"><code className="connector-page-code">hc1\_list\_dashboards</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the hc1 analytics dashboards the signed-in user can see.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_cases" data-action-label="List Cases" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Cases</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_cases" aria-label="Copy hc1_list_cases"><code className="connector-page-code">hc1\_list\_cases</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List cases (service issues) in hc1.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_contacts" data-action-label="List Contacts" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Contacts</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_contacts" aria-label="Copy hc1_list_contacts"><code className="connector-page-code">hc1\_list\_contacts</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List contacts (providers and staff) in hc1.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_memos" data-action-label="List Memos" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Memos</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_memos" aria-label="Copy hc1_list_memos"><code className="connector-page-code">hc1\_list\_memos</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List memos (notes) in hc1.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_organizations" data-action-label="List Organizations" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Organizations</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_organizations" aria-label="Copy hc1_list_organizations"><code className="connector-page-code">hc1\_list\_organizations</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List organizations (clinics and accounts) in hc1.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_get_organization" data-action-label="Get Organization" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Organization</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_organization" aria-label="Copy hc1_get_organization"><code className="connector-page-code">hc1\_get\_organization</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get one organization by id with all of its fields.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_get_record" data-action-label="Get Record" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Record</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_record" aria-label="Copy hc1_get_record"><code className="connector-page-code">hc1\_get\_record</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get any hc1 record by id and record type.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_search_records" data-action-label="Search Records" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search Records</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_search_records" aria-label="Copy hc1_search_records"><code className="connector-page-code">hc1\_search\_records</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search hc1 records of chosen types by text.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_get_record_type_metadata" data-action-label="Get Record Type Metadata" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Record Type Metadata</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_record_type_metadata" aria-label="Copy hc1_get_record_type_metadata"><code className="connector-page-code">hc1\_get\_record\_type\_metadata</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the fields and saved list views of an hc1 record type.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_view_records" data-action-label="List View Records" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List View Records</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_view_records" aria-label="Copy hc1_list_view_records"><code className="connector-page-code">hc1\_list\_view\_records</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the records in a saved hc1 list view.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_tasks" data-action-label="List Tasks" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Tasks</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_tasks" aria-label="Copy hc1_list_tasks"><code className="connector-page-code">hc1\_list\_tasks</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List tasks in hc1.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_get_tenant_settings" data-action-label="Get Tenant Settings" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Tenant Settings</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_get_tenant_settings" aria-label="Copy hc1_get_tenant_settings"><code className="connector-page-code">hc1\_get\_tenant\_settings</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the hc1 tenant settings, subscription and disk usage.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_active_user_emails" data-action-label="List Active User Emails" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Active User Emails</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_active_user_emails" aria-label="Copy hc1_list_active_user_emails"><code className="connector-page-code">hc1\_list\_active\_user\_emails</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the email addresses of all active hc1 users.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_announcements" data-action-label="List Announcements" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Announcements</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_announcements" aria-label="Copy hc1_list_announcements"><code className="connector-page-code">hc1\_list\_announcements</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List current hc1 system announcements.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hc1_list_attachment_statuses" data-action-label="List Attachment Statuses" data-action-scopes="" data-action-auth="Username and Password" data-action-auth-scopes="{&#x22;Username and Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Attachment Statuses</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hc1_list_attachment_statuses" aria-label="Copy hc1_list_attachment_statuses"><code className="connector-page-code">hc1\_list\_attachment\_statuses</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the review statuses an hc1 attachment can have.</div>
      </div>
    </div>
  </div>
</div>


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