Breezy HR
API actions for the Breezy HR integration.
Breezy HR
Manage positions and candidates in Breezy HR.
Add candidate note
Adds an internal note to a Breezy HR candidate profile.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
candidate_id | string | Yes | The Breezy HR candidate ID to attach the note to. |
note | string | Yes | The note text to store on the candidate profile. |
visibility | string | No | Optional visibility such as team or hiring_manager. |
Response
{
"note": {},
"status": "mock_value"
}Create candidate
Creates a new candidate on a Breezy HR position with optional contact details.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
position_id | string | Yes | The Breezy HR position ID to add the candidate to. |
name | string | Yes | Full name of the candidate. |
email | string | Yes | Primary email address for the candidate. |
phone | string | No | Optional phone number for the candidate. |
resume_url | string | No | Optional URL to the candidate's resume or CV. |
source | string | No | Optional candidate source label (e.g., referral, careers page). |
Response
{
"candidate": {},
"status": "mock_value"
}Get position details
Fetches details for a specific Breezy HR position.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
position_id | string | Yes | The Breezy HR position ID to fetch. |
Response
{
"position": {},
"status": "mock_value"
}List candidates
Lists candidates for a Breezy HR position with an optional stage filter.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
position_id | string | Yes | The Breezy HR position ID to list candidates for. |
stage | string | No | Optional pipeline stage slug to filter candidates. |
Response
{
"candidates": [
{}
],
"status": "mock_value"
}List positions
Retrieves open and closed positions from Breezy HR with an optional status filter.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Optional position status such as open, closed, or draft. |
Response
{
"positions": [
{}
],
"status": "mock_value"
}