> 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/data-overview.md).

# 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


---

# 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/data-overview.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.