> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BreezyHR

> How to set up the BreezyHR connector, plus the actions and events that are available.

![BreezyHR](https://stackone-logos.com/api/breezy/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/breezyhr/changelog.md)

[47 actions](#actions) · [10 events](#events) · 2 auth methods

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Basic Auth · Connector Profile](https://docs.stackone.com/connectors/breezyhr/guides/connector-profile/basic-auth.md)
>
> Connect using your BreezyHR administrator email and password.

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/breezyhr/guides/connector-profile/api-key.md)
>
> Uses an API key (a personal access token) created under My Settings > API Keys in BreezyHR. The key inherits the permiss...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Basic Auth · Link Account](https://docs.stackone.com/connectors/breezyhr/guides/link-account/basic-auth.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/breezyhr/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

Basic Auth

No auth methods found

47 actions

ActionDescription

Get User`breezyhr_get_user`

Get information about the authenticated user or another user by ID

Get User Details`breezyhr_get_user_details`

Get detailed information about the currently authenticated user

Sign Out`breezyhr_signout`

Sign out the current user and invalidate the session token

List Companies`breezyhr_list_companies`

Get all companies accessible to the authenticated user

Get Company Details`breezyhr_get_company`

Get detailed information about a specific company

Get Candidate Custom Attributes`breezyhr_get_company_candidate_custom_attributes`

Get custom attribute definitions for candidates in a company

Get Position Custom Attributes`breezyhr_get_company_position_custom_attributes`

Get custom attribute definitions for positions in a company

List All Positions`breezyhr_list_positions`

Get all positions/jobs for the company

Get A Specific Position`breezyhr_get_position`

Get details of a specific position by ID

Create A New Position`breezyhr_create_position`

Create a new job position

Update A Position`breezyhr_update_position`

Update details for a given position

Update Position State`breezyhr_update_position_state`

Update the state of a position (draft, published, closed, archived)

Get Position Activity Stream`breezyhr_get_position_stream`

Get activity stream for a position

Get Position Team Members`breezyhr_get_position_team`

Get team members assigned to a position

Get Position Custom Fields`breezyhr_get_position_custom_fields`

Get custom field values for a position. Only returns fields that already have values set on the position.

Update Position Custom Field`breezyhr_update_position_custom_field`

Update a specific custom field value for a position. The field must already have a value set on the position.

List Position Candidates`breezyhr_list_candidates`

Get all candidates for a specific position with abbreviated candidate objects

Search Candidates By Email`breezyhr_search_candidates`

Retrieve all candidates with entered email address across all positions

Get Candidate Details`breezyhr_get_candidate`

Get detailed information about a specific candidate

Create Candidate`breezyhr_create_candidate`

Add a new candidate to a position

Update Candidate`breezyhr_update_candidate`

Update candidate information

Move Candidate To Another Position`breezyhr_move_candidate`

Move a candidate from one position to another

Update Candidate Stage`breezyhr_update_candidate_stage`

Move candidate to a different stage in the hiring pipeline

Get Candidate Activity Stream`breezyhr_get_candidate_stream`

Get activity stream/timeline for a candidate

Add Note To Candidate Stream`breezyhr_add_candidate_stream_note`

Add a note to candidate's discussion stream

Get Candidate Metadata`breezyhr_get_candidate_meta`

Get metadata information for a candidate

Get Candidate Resume`breezyhr_get_candidate_resume`

Get the resume file for a candidate

Get Candidate Documents`breezyhr_get_candidate_documents`

Get all documents attached to a candidate

Get Candidate Conversation`breezyhr_get_candidate_conversation`

Get email conversation thread for a candidate

Send Message To Candidate`breezyhr_send_candidate_message`

Add a new conversation message for the candidate

Add Candidate Education Entry`breezyhr_update_candidate_education`

Add an education entry to a candidate

Add Candidate Work History Entry`breezyhr_update_candidate_work_history`

Add a work history entry to a candidate

Get Candidate Questionnaires`breezyhr_get_candidate_questionnaires`

Get questionnaires submitted by a candidate

Send Questionnaire To Candidate`breezyhr_send_questionnaire_to_candidate`

Send a questionnaire to a candidate

Update Candidate Scorecard`breezyhr_update_candidate_scorecard`

Update scorecard/evaluation for a candidate

Get Candidate Assessments`breezyhr_get_candidate_assessments`

Get assessment results for a candidate

Get Candidate Background Checks`breezyhr_get_candidate_background_checks`

Get background check results for a candidate

Add Candidate Custom Attribute`breezyhr_update_candidate_custom_attribute`

Add or update a custom attribute on a candidate. This is different from update\_candidate\_custom\_field.

Get Candidate Custom Fields`breezyhr_get_candidate_custom_fields`

Get custom field values for a candidate. Returns fields defined at company level with their per-candidate values.

Update Candidate Custom Field`breezyhr_update_candidate_custom_field`

Update a specific custom field value for a candidate. Use get\_candidate\_custom\_fields to get the custom\_field\_id.

List Pipelines`breezyhr_list_pipelines`

Get all hiring pipelines for a company, keyed by pipeline ID

Get Pipeline Details`breezyhr_get_pipeline`

Get details of a specific hiring pipeline

List Questionnaires`breezyhr_list_questionnaires`

Get all questionnaires for a company

Get Questionnaire Details`breezyhr_get_questionnaire`

Get details of a specific questionnaire

Update Questionnaire Response`breezyhr_update_candidate_questionnaire_response`

Update or submit questionnaire responses for a candidate

List Templates`breezyhr_list_templates`

Get all email and message templates for a company

Get Template Details`breezyhr_get_template`

Get details of a specific email or message template

## Events

Tags

Select all
|
Clear

Candidates

Notes

Positions

Webhooks

No tags found

10 events

EventDescriptionTags

Candidate Added`breezyhr_webhook_candidate_added`

Emitted when a new candidate is added to a position. Maps to BreezyHR event `candidateAdded`.

CandidatesWebhooks

Candidate Deleted`breezyhr_webhook_candidate_deleted`

Emitted when a candidate is deleted from a position. Maps to BreezyHR event `candidateDeleted`.

CandidatesWebhooks

Candidate Status Updated`breezyhr_webhook_candidate_status_updated`

Emitted when a candidate's status changes within a position's pipeline. Maps to BreezyHR event `candidateStatusUpdated`.

CandidatesWebhooks

Position Added`breezyhr_webhook_company_position_added`

Emitted when a new position is created in the company. Maps to BreezyHR event `companyPositionAdded`.

PositionsWebhooks

Position Updated`breezyhr_webhook_company_position_updated`

Emitted when a position's details are updated. Maps to BreezyHR event `companyPositionUpdated`.

PositionsWebhooks

Position Deleted`breezyhr_webhook_company_position_deleted`

Emitted when a position is deleted from the company. Maps to BreezyHR event `companyPositionDeleted`.

PositionsWebhooks

Position State Updated`breezyhr_webhook_company_position_state_updated`

Emitted when a position's state changes (e.g. draft, published, closed, archived). Maps to BreezyHR event \`companyPositi...

PositionsWebhooks

Note Posted`breezyhr_webhook_company_note_posted`

Emitted when a new note is posted in the company. Maps to BreezyHR event `companyNotePosted`.

NotesWebhooks

Note Updated`breezyhr_webhook_company_note_updated`

Emitted when a note is updated in the company. Maps to BreezyHR event `companyNoteUpdated`.

NotesWebhooks

Note Deleted`breezyhr_webhook_company_note_deleted`

Emitted when a note is deleted from the company. Maps to BreezyHR event `companyNoteDeleted`.

NotesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.