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

# HighLevel

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

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

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">12 actions</a> · 2 auth methods</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">CRM</span>
      <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 · OAuth 2.0" href="/connectors/highlevel/guides/connector-profile/oauth-2-0" icon="https://stackone-logos.com/api/highlevel/filled/svg" horizontal>
        Requires a HighLevel Marketplace app. An agency install reads every user and sub-account in the agency; a sub-account in...
      </Card>

      <Card title="Connector Profile · Private Integration Token" href="/connectors/highlevel/guides/connector-profile/private-integration-token" icon="https://stackone-logos.com/api/highlevel/filled/svg" horizontal>
        No app registration required. An agency token with the agency id reads every user and sub-account in the agency; a sub-a...
      </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 · OAuth 2.0" href="/connectors/highlevel/guides/link-account/oauth-2-0" icon="https://stackone-logos.com/api/highlevel/filled/svg" horizontal />

      <Card title="Link Account · Private Integration Token" href="/connectors/highlevel/guides/link-account/private-integration-token" icon="https://stackone-logos.com/api/highlevel/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 className="connector-actions-scopes" data-connector-actions-auth>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-auth-toggle aria-expanded="false">
          <span>Authentication type<span data-connector-actions-auth-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-auth-search placeholder="Search auth methods..." aria-label="Search auth methods" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-auth-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-auth-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="OAuth 2.0" data-connector-actions-auth-filter />

            <span>OAuth 2.0</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="Private Integration Token" data-connector-actions-auth-filter />

            <span>Private Integration Token</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-auth-empty hidden>No auth methods found</div>
        </div>
      </div>

      <div className="connector-actions-scopes" data-connector-actions-scopes>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-scopes-toggle aria-expanded="false">
          <span>Scopes<span data-connector-actions-scopes-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-scope-search placeholder="Search scopes..." aria-label="Search scopes" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-scopes-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-scopes-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="companies.readonly" data-connector-actions-scope-filter />

            <span>companies.readonly</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="locations.readonly" data-connector-actions-scope-filter />

            <span>locations.readonly</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="users.readonly" data-connector-actions-scope-filter />

            <span>users.readonly</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-scopes-empty hidden>No scopes found</div>
        </div>
      </div>
    </div>
  </div>

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

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid connector-meta-library-grid--three-col">
      <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 className="meta-library-grid-header-cell">Required scopes</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_get_company" data-action-label="Get Agency" data-action-scopes="companies.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;companies.readonly&#x22;],&#x22;Private Integration Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Agency</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="highlevel_get_company" aria-label="Copy highlevel_get_company"><code className="connector-page-code">highlevel\_get\_company</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the HighLevel agency (company) record.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="companies.readonly" aria-label="Copy scope companies.readonly"><code className="connector-page-code">companies.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_get_me" data-action-label="Get Unified Credentials" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_get_me" aria-label="Copy highlevel_unified_get_me"><code className="connector-page-code">highlevel\_unified\_get\_me</code></button></div>
        </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_list_organizations" data-action-label="List Unified Organizations" data-action-scopes="locations.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;locations.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_list_organizations" aria-label="Copy highlevel_unified_list_organizations"><code className="connector-page-code">highlevel\_unified\_list\_organizations</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List unified organizations (sub-accounts) in a HighLevel agency.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="locations.readonly" aria-label="Copy scope locations.readonly"><code className="connector-page-code">locations.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_get_organization" data-action-label="Get Unified Organization" data-action-scopes="locations.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;locations.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_get_organization" aria-label="Copy highlevel_unified_get_organization"><code className="connector-page-code">highlevel\_unified\_get\_organization</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a unified HighLevel organization (sub-account) by ID.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="locations.readonly" aria-label="Copy scope locations.readonly"><code className="connector-page-code">locations.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_list_roles" data-action-label="List Unified Roles" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_list_roles" aria-label="Copy highlevel_unified_list_roles"><code className="connector-page-code">highlevel\_unified\_list\_roles</code></button></div>
        </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_get_role" data-action-label="Get Unified Role" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_get_role" aria-label="Copy highlevel_unified_get_role"><code className="connector-page-code">highlevel\_unified\_get\_role</code></button></div>
        </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_list_users" data-action-label="List Unified Users" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_list_users" aria-label="Copy highlevel_unified_list_users"><code className="connector-page-code">highlevel\_unified\_list\_users</code></button></div>
        </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_unified_get_user" data-action-label="Get Unified User" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#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="highlevel_unified_get_user" aria-label="Copy highlevel_unified_get_user"><code className="connector-page-code">highlevel\_unified\_get\_user</code></button></div>
        </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_list_locations" data-action-label="List Sub-Accounts" data-action-scopes="locations.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;locations.readonly&#x22;],&#x22;Private Integration Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Sub-Accounts</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="highlevel_list_locations" aria-label="Copy highlevel_list_locations"><code className="connector-page-code">highlevel\_list\_locations</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search the sub-accounts (locations) of a HighLevel agency.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="locations.readonly" aria-label="Copy scope locations.readonly"><code className="connector-page-code">locations.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_get_location" data-action-label="Get Sub-Account" data-action-scopes="locations.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;locations.readonly&#x22;],&#x22;Private Integration Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Sub-Account</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="highlevel_get_location" aria-label="Copy highlevel_get_location"><code className="connector-page-code">highlevel\_get\_location</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a HighLevel sub-account (location) by ID.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="locations.readonly" aria-label="Copy scope locations.readonly"><code className="connector-page-code">locations.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_list_users" data-action-label="List Users" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Users</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="highlevel_list_users" aria-label="Copy highlevel_list_users"><code className="connector-page-code">highlevel\_list\_users</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search agency and sub-account users in a HighLevel agency.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="highlevel_get_user" data-action-label="Get User" data-action-scopes="users.readonly" data-action-auth="OAuth 2.0,Private Integration Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[&#x22;users.readonly&#x22;],&#x22;Private Integration Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get User</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="highlevel_get_user" aria-label="Copy highlevel_get_user"><code className="connector-page-code">highlevel\_get\_user</code></button></div>
        </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="users.readonly" aria-label="Copy scope users.readonly"><code className="connector-page-code">users.readonly</code></button></div>
        </div>
      </div>
    </div>
  </div>
</div>