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

# Connect BreezyHR with API Key – StackOne Hub

> Link a BreezyHR account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using BreezyHR actions.

> [!WARNING]
>
> Your API key is shown only once, when it is created. Copy it before you close the dialog.

## Create an API key in BreezyHR

BreezyHR calls these keys personal access tokens. A key belongs to the user who creates it and carries that user's permissions, so sign in to [BreezyHR](https://app.breezy.hr/signin) as a Company Administrator before you start.

**1. Open your personal settings**

Click your user icon in the lower-left corner of BreezyHR, then select **My Settings**.

![BreezyHR account menu open from the user icon with My Settings highlighted](https://mintcdn.com/stackone-60/5TAPZfgQVA9zsRlP/connectors/breezyhr/images/api-key-config-my-settings.png?fit=max\&auto=format\&n=5TAPZfgQVA9zsRlP\&q=85\&s=38bc89d43ecf887fe4da7bdfa93525c1)

**2. Open the API Keys tab**

On the **My Settings** page, select the **API Keys** tab.

![My Settings page with the API Keys tab highlighted alongside Profile, Shortcuts, Appearance, and Signature](https://mintcdn.com/stackone-60/5TAPZfgQVA9zsRlP/connectors/breezyhr/images/api-key-config-api-keys-tab.png?fit=max\&auto=format\&n=5TAPZfgQVA9zsRlP\&q=85\&s=8a5fb5cb938482a6584dbb35ed1cf465)

**3. Create a new key**

Click **Create API Key** to open the key dialog.

![API Keys tab with the Create API Key button highlighted](https://mintcdn.com/stackone-60/5TAPZfgQVA9zsRlP/connectors/breezyhr/images/api-key-config-create-api-key.png?fit=max\&auto=format\&n=5TAPZfgQVA9zsRlP\&q=85\&s=21160f302a00af89b62291a6dbff4ee2)

**4. Name the key and set its expiration**

Fill in the dialog, then click **Create Key**.

<ul>
  <li>Enter a **Name** that identifies this integration, for example `StackOne Integration`.</li>
  <li>Choose an **Expiration**. Leave it on **No expiration** so the connection keeps working.</li>
</ul>

![Create API Key dialog with the Name field, Expiration dropdown, and Create Key button highlighted](https://mintcdn.com/stackone-60/5TAPZfgQVA9zsRlP/connectors/breezyhr/images/api-key-config-create-key-dialog.png?fit=max\&auto=format\&n=5TAPZfgQVA9zsRlP\&q=85\&s=bf1e6ae2ee74807be30b32a6190cf2df)

**5. Copy the key into StackOne**

BreezyHR shows the new key once, in the **Your New API Key** dialog. Click **Copy**, then paste the value into the **API Key** field in StackOne Hub. The key begins with `breezy_pat_`.

![Your New API Key dialog with the Copy button highlighted and the token value masked](https://mintcdn.com/stackone-60/5TAPZfgQVA9zsRlP/connectors/breezyhr/images/api-key-config-copy-key.png?fit=max\&auto=format\&n=5TAPZfgQVA9zsRlP\&q=85\&s=bc151398de5be8147fc0d9172c410b00)

## Add your Company ID

The **Company ID** is optional and is used for webhook registration and company-scoped calls. Leave it empty unless you plan to use BreezyHR webhook events.

**1. Copy the Company ID into StackOne**

Once the account is connected, run the `list_companies` action and copy the `_id` value of the company you want into the **Company ID** field in StackOne Hub.

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

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

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


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