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

![BrightHR](https://stackone-logos.com/api/brighthr/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/brighthr/changelog.md)

[4 actions](#actions) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/brighthr/guides/connector-profile/oauth-2-0.md)
>
> Requires a BrightHR administrator to register an API application in BrightHR API Management at account.brighthr.com/mana...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

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

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/brighthr/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

4 actions

ActionDescription

List Absences`brighthr_list_absences`

List approved absences (holiday, sickness, and other leave) for a single employee in BrightHR within an optional date wi...

List Blip Clockings`brighthr_list_blip_clockings`

List Blip clock-in, clock-out, and break attendance events for a single employee within an optional date window.

List Employees`brighthr_list_employees`

List employees in your BrightHR organisation with optional filtering, sorting, and cursor pagination.

Set Employee External Reference`brighthr_set_employee_external_reference`

Set or overwrite the external reference identifier stored against a BrightHR employee.


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