> For the complete documentation index, see [llms.txt](https://docs.coupler.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coupler.io/sources/category/other/breezy-hr.md).

# Breezy HR

Connect Breezy HR to Coupler.io to pull job positions, candidates, and pipeline stages into Google Sheets or BigQuery automatically.

Breezy HR is a recruiting and applicant tracking system (ATS) that helps teams manage job postings, candidates, and hiring pipelines in one place. Connecting it to Coupler.io lets you pull your recruiting data into spreadsheets, dashboards, or AI tools — without any manual exports.

## Why connect Breezy HR to Coupler.io?

* **Centralize recruiting data** — combine positions, candidates, and pipeline stages in a single destination
* **Track hiring progress** — monitor where candidates stand across all your open roles
* **Build custom reports** — use your data in Google Sheets, Looker Studio, BigQuery, or AI tools like ChatGPT or Claude
* **Automate updates** — schedule recurring syncs so your reports always reflect the latest recruiting activity

## Prerequisites

* An active Breezy HR account
* Access to your Breezy HR API key (available in your account settings)
* A Coupler.io account (free plan works to get started)

## Quick start

{% hint style="success" %}
If you want a full recruiting overview, add all three entities — Positions, Candidates, and Pipelines — to a single data flow and use the Join transformation to connect them.
{% endhint %}

## How to connect

{% stepper %}
{% step %}
**Create a new data flow.** Log in to Coupler.io, go to the Data flows section, and click **Add data flow**. Search for and select **Breezy HR** as your source.
{% endstep %}

{% step %}
**Enter your Breezy HR API key.** In Breezy HR, go to **Account Settings → Integrations → API** and copy your API key. Paste it into the API key field in Coupler.io.
{% endstep %}

{% step %}
**Select an entity.** Choose which data you want to pull: Positions, Candidates, or Pipelines. You can add more sources to the same data flow later.
{% endstep %}

{% step %}
**Choose a destination.** Select where you want your data to land — Google Sheets, Excel, BigQuery, Looker Studio, or an AI destination like ChatGPT, Claude, Gemini, Cursor, Perplexity, or OpenClaw.
{% endstep %}

{% step %}
**Run the data flow.** Click **Run** to trigger a manual sync and confirm your data arrives correctly.
{% endstep %}
{% endstepper %}

## Breezy HR data overview

Coupler.io pulls three core entities from Breezy HR, giving you a complete picture of your recruiting operations — from open roles to individual candidate progress.

## Available entities

| Entity     | Description                                                                                     |
| ---------- | ----------------------------------------------------------------------------------------------- |
| Positions  | Job roles defined in your Breezy HR account, including open, closed, and draft listings         |
| Candidates | Individuals who have applied or been added to a position, with personal and application details |
| Pipelines  | The stages that make up your hiring workflow and where each candidate currently sits            |

## Positions

#### Fields

| Field        | Description                                             |
| ------------ | ------------------------------------------------------- |
| Position ID  | Unique identifier for the role                          |
| Name         | Job title                                               |
| State        | Status of the position (e.g., published, closed, draft) |
| Department   | Department the role belongs to                          |
| Location     | Office or remote location for the role                  |
| Created date | When the position was created                           |
| Updated date | When the position was last modified                     |
| Type         | Employment type (full-time, part-time, contract, etc.)  |

## Candidates

#### Fields

| Field        | Description                                                  |
| ------------ | ------------------------------------------------------------ |
| Candidate ID | Unique identifier for the applicant                          |
| Name         | Full name of the candidate                                   |
| Email        | Primary contact email                                        |
| Phone        | Contact phone number                                         |
| Source       | How the candidate found the role (e.g., job board, referral) |
| Stage        | Current stage in the hiring pipeline                         |
| Position     | The role the candidate applied for                           |
| Created date | When the candidate record was created                        |
| Updated date | When the candidate record was last updated                   |
| Tags         | Labels applied to the candidate for categorization           |

## Pipelines

#### Fields

| Field       | Description                               |
| ----------- | ----------------------------------------- |
| Pipeline ID | Unique identifier for the pipeline        |
| Name        | Pipeline name                             |
| Stage name  | Name of each stage within the pipeline    |
| Stage order | Sequence number of each stage             |
| Position    | The role this pipeline is associated with |

## Common data combinations

* **Candidates + Positions** — Join on Position ID to see which candidates are applying for which roles, filtered by department or location
* **Candidates + Pipelines** — Join on Stage to understand how many candidates are in each hiring stage across all open roles
* **Positions (multiple accounts)** — Use Append to combine job listings from multiple Breezy HR accounts into a single report

## Use cases by role

{% tabs %}
{% tab title="HR & Recruiting" %}

* Track time-to-hire by measuring how long candidates spend in each pipeline stage
* Build a live headcount report by monitoring published positions and their fill dates
* Identify top candidate sources by grouping the Source field across all candidates
  {% endtab %}

{% tab title="People Ops" %}

* Monitor hiring velocity across departments by combining Positions and Candidates data
* Create diversity and sourcing dashboards in Looker Studio using candidate tags and sources
* Feed candidate pipeline data into Claude or ChatGPT to generate weekly recruiting summaries
  {% endtab %}

{% tab title="Leadership" %}

* Get a high-level view of open roles and hiring funnel health in a single BigQuery or Google Sheets dashboard
* Track recruiting KPIs like open positions by department, pipeline conversion rates, and sourcing mix
  {% endtab %}
  {% endtabs %}

## Platform-specific notes

* Breezy HR candidate records include all positions a candidate has applied to, so you may see duplicate candidate names across different positions — use Candidate ID as your unique key
* The pipeline stages returned depend on your Breezy HR account configuration; stage names and order are customizable per position
* Closed and archived positions are included in the Positions entity — filter by the State field if you only want active listings
* Candidate source data is only populated when a source was explicitly set during application or manual entry

## Breezy HR common issues

### Connection issues

<details>

<summary>My API key is not being accepted</summary>

Double-check that you copied the full API key from Breezy HR without any leading or trailing spaces. In Breezy HR, go to **Account Settings → Integrations → API** to find and regenerate your key if needed. If your key was recently regenerated, make sure you've updated it in Coupler.io as well.

</details>

<details>

<summary>The data flow connects but returns no data</summary>

This usually means your Breezy HR account has no records for the selected entity, or all positions are in a draft state not visible via the API. Check that the entity you selected (Positions, Candidates, or Pipelines) has at least one record in your Breezy HR account.

</details>

### Missing data

<details>

<summary>Some candidates are missing from my results</summary>

Candidates who were archived or deleted in Breezy HR may not appear in the export. Also confirm that the candidates are associated with an active or published position — candidates tied only to draft positions may not be returned.

</details>

<details>

<summary>Pipeline stages are missing or incomplete</summary>

Pipeline stages are configured per position in Breezy HR. If a position uses a non-default pipeline, the stages will reflect that position's custom setup. Make sure you're joining Pipelines data with the correct Position ID to get the right stages.

</details>

<details>

<summary>Candidate source field is blank</summary>

The source field is only populated when it was explicitly set during the application process or added manually in Breezy HR. Candidates added without a source attribution will have a blank value — this is expected behavior from the Breezy HR API.

</details>

### Permission errors

<details>

<summary>I get a 401 or "unauthorized" error</summary>

This means your API key is invalid or has been revoked. Regenerate your API key in **Breezy HR → Account Settings → Integrations → API**, then update the key in your Coupler.io data flow settings.

{% hint style="warning" %}
Only account owners and admins in Breezy HR can access and generate API keys. If you don't see the API section, ask your Breezy HR administrator.
{% endhint %}

</details>

### Data discrepancies

<details>

<summary>Candidate counts in Coupler.io don't match Breezy HR's dashboard</summary>

Breezy HR's dashboard may apply default filters (e.g., hiding disqualified candidates). The Coupler.io export pulls all candidate records available through the API, including disqualified ones. Filter by the Stage field in your destination to match what you see in Breezy HR.

</details>

<details>

<summary>A position shows as open in Breezy HR but closed in my export</summary>

This can happen if the position state was changed after your last data flow run. Run the data flow manually again to pull the latest status, or schedule more frequent syncs for time-sensitive reporting.

</details>

### Rate limits

<details>

<summary>My data flow fails with a rate limit error</summary>

Breezy HR's API has rate limits that can be hit when syncing large volumes of candidates or running multiple data flows simultaneously. Space out your data flows or reduce sync frequency if you hit this issue. If it persists, contact Breezy HR support to review your API usage limits.

</details>

## Breezy HR FAQ

<details>

<summary>Where do I find my Breezy HR API key?</summary>

Log in to Breezy HR and go to **Account Settings → Integrations → API**. Your API key will be listed there. Only account owners and admins can access this section. If you don't see it, ask your Breezy HR administrator to share the key or grant you the necessary access level.

</details>

<details>

<summary>Can I pull data from multiple Breezy HR accounts?</summary>

Yes. Add each account as a separate source within the same data flow, using the API key for each account. Then use Coupler.io's **Append** transformation to combine them into a single dataset in your destination.

</details>

<details>

<summary>Can I connect Breezy HR data to AI tools?</summary>

Absolutely. Coupler.io supports AI destinations including ChatGPT, Claude, Gemini, Cursor, Perplexity, and OpenClaw. You can send your candidate or pipeline data directly to these tools to generate recruiting summaries, identify bottlenecks, or draft reports.

</details>

<details>

<summary>Why do I see the same candidate listed multiple times?</summary>

In Breezy HR, a candidate can apply to more than one position, creating a separate record for each application. This is expected — use Candidate ID to identify unique individuals, and filter or group by Position ID to separate the applications.

</details>

<details>

<summary>Can I combine Positions, Candidates, and Pipelines in one report?</summary>

Yes. Add all three as sources in a single data flow and use Coupler.io's **Join** transformation to link them. Join Candidates to Positions on Position ID, and join Pipelines on Stage to build a full recruiting funnel view.

</details>

<details>

<summary>Does Coupler.io pull historical candidate data or only current records?</summary>

Coupler.io pulls whatever is currently available through the Breezy HR API, which includes all candidate records regardless of when they were created — as long as they haven't been permanently deleted. There is no date range filter required; all records are returned by default.

</details>

<details>

<summary>How do I track which pipeline stage candidates are stuck in?</summary>

Pull the Candidates entity (which includes the current Stage field) and use Coupler.io's **Aggregate** transformation to count candidates by Stage. Load this into Google Sheets or Looker Studio to visualize your funnel and spot bottlenecks.

{% hint style="info" %}
See [Data Overview](#breezy-hr-data-overview) for a full list of Candidate fields, including Stage and Source, and tips on combining entities.
{% endhint %}

</details>

<details>

<summary>What should I do if my data flow stops working after it was running fine?</summary>

The most common cause is an expired or regenerated API key. Check your Breezy HR API settings to confirm the key is still active, then verify it matches what's entered in your Coupler.io data flow. If the key is correct, check for any changes to your Breezy HR account permissions.

{% hint style="info" %}
For a full list of connection and permission errors, see [Common Issues](#breezy-hr-common-issues).
{% endhint %}

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.coupler.io/sources/category/other/breezy-hr.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
