Lodol Docs

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

ParameterTypeRequiredDescription
candidate_idstringYesThe Breezy HR candidate ID to attach the note to.
notestringYesThe note text to store on the candidate profile.
visibilitystringNoOptional 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

ParameterTypeRequiredDescription
position_idstringYesThe Breezy HR position ID to add the candidate to.
namestringYesFull name of the candidate.
emailstringYesPrimary email address for the candidate.
phonestringNoOptional phone number for the candidate.
resume_urlstringNoOptional URL to the candidate's resume or CV.
sourcestringNoOptional 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

ParameterTypeRequiredDescription
position_idstringYesThe 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

ParameterTypeRequiredDescription
position_idstringYesThe Breezy HR position ID to list candidates for.
stagestringNoOptional 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

ParameterTypeRequiredDescription
statusstringNoOptional position status such as open, closed, or draft.

Response

{
  "positions": [
    {}
  ],
  "status": "mock_value"
}

On this page