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

# BrightHR

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

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

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-beta connector-page-stage-tag">Beta</span><span>v1.0.0</span></div>
  </div>

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

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">HRIS</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/brighthr/guides/connector-profile/oauth-2-0" icon="https://stackone-logos.com/api/brighthr/filled/svg" horizontal>
        Requires a BrightHR administrator to register an API application in BrightHR API Management at account.brighthr.com/mana...
      </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/brighthr/guides/link-account/oauth-2-0" icon="https://stackone-logos.com/api/brighthr/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>4 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="brighthr_list_absences" data-action-label="List Absences" data-action-scopes="" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Absences</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="brighthr_list_absences" aria-label="Copy brighthr_list_absences"><code className="connector-page-code">brighthr\_list\_absences</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List approved absences (holiday, sickness, and other leave) for a single employee in BrightHR within an optional date wi...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="brighthr_list_blip_clockings" data-action-label="List Blip Clockings" data-action-scopes="" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Blip Clockings</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="brighthr_list_blip_clockings" aria-label="Copy brighthr_list_blip_clockings"><code className="connector-page-code">brighthr\_list\_blip\_clockings</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List Blip clock-in, clock-out, and break attendance events for a single employee within an optional date window.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="brighthr_list_employees" data-action-label="List Employees" data-action-scopes="" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Employees</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="brighthr_list_employees" aria-label="Copy brighthr_list_employees"><code className="connector-page-code">brighthr\_list\_employees</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List employees in your BrightHR organisation with optional filtering, sorting, and cursor pagination.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="brighthr_set_employee_external_reference" data-action-label="Set Employee External Reference" data-action-scopes="" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Set Employee External Reference</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="brighthr_set_employee_external_reference" aria-label="Copy brighthr_set_employee_external_reference"><code className="connector-page-code">brighthr\_set\_employee\_external\_reference</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Set or overwrite the external reference identifier stored against a BrightHR employee.</div>
      </div>
    </div>
  </div>
</div>