> 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

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 %}

## Available entities

| Entity     | What it contains                                                      |
| ---------- | --------------------------------------------------------------------- |
| Positions  | Open and filled roles, job details, department, and status            |
| Candidates | Applicant profiles, contact info, and application history             |
| Pipelines  | Hiring stages and candidate progression through your recruitment flow |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.