- Category: hr talent & recruitment
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 48
- Triggers: 0
- Slug:
BREEZY_HR - Version: 20261101_00
Tools
Add Candidate Custom Attribute
Add Candidate Custom Attribute
Add Candidate Document
Add Candidate Document
BREEZY_HR_ADD_CANDIDATE_DOCUMENTUpload a document for an existing candidate on a specified Breezy HR position. Use this to attach additional files, such as a cover letter, portfolio, or certification, to the candidate’s application.Input Parameters
Output
Add Candidate Education
Add Candidate Education
Add Candidate Note
Add Candidate Note
BREEZY_HR_ADD_CANDIDATE_NOTEAdds a note to a candidate’s discussion stream in Breezy HR. Use this action when you need to record observations, interview feedback, or any communication about a candidate directly in their profile. The note becomes part of the candidate’s activity history and is visible to all users with access to the candidate.Input Parameters
Output
Add candidate resume
Add candidate resume
BREEZY_HR_ADD_CANDIDATE_RESUMEUpload a resume for an existing candidate on a specified Breezy HR position. Use this to add a resume or replace the candidate’s current resume.Input Parameters
Output
Add Candidate Work History
Add Candidate Work History
BREEZY_HR_ADD_CANDIDATE_WORK_HISTORYAdd a work history entry to an existing candidate for a position in Breezy HR, recording employment details such as company, title, dates, and responsibilities. The entry is appended rather than updating an existing entry for the same company.Input Parameters
Output
Add candidate to position
Add candidate to position
BREEZY_HR_CREATE_CANDIDATEAdd a new candidate to a position in Breezy HR. Use when you need to create or add a candidate to a specific job position. This action allows you to programmatically add candidates to positions with various details including contact information, education, work history, social profiles, and custom attributes. The candidate can be marked as ‘sourced’ (direct hire) or ‘applied’ (applicant tracking). Note: If origin is ‘applied’, email_address is required. For ‘sourced’ candidates, email is optional but recommended.Input Parameters
Output
Create Candidate From Resume
Create Candidate From Resume
BREEZY_HR_CREATE_CANDIDATE_FROM_RESUMEUpload and parse a resume file to create a new candidate in Breezy HR. Use this action when you need to add a new job candidate by uploading their resume. The resume is parsed and candidate information is automatically extracted and associated with the specified position. The candidate will be placed in the default ‘applied’ stage unless a different stage_id is specified.Input Parameters
Output
Create Position
Create Position
BREEZY_HR_CREATE_POSITIONCreate a new Breezy HR position for a company with details such as title, description, location, and employment type.Input Parameters
Output
Create Webhook Endpoint
Create Webhook Endpoint
BREEZY_HR_CREATE_WEBHOOK_ENDPOINTCreate a new webhook endpoint to receive event notifications from Breezy HR. Use this action when you need to set up real-time notifications for events such as candidates being added, deleted, or having their status updated. The response includes a secret key that should be stored securely to verify incoming webhook signatures. This action is idempotent based on the endpoint URL and subscribed events.Input Parameters
Output
Delete Webhook Endpoint
Delete Webhook Endpoint
BREEZY_HR_DELETE_WEBHOOK_ENDPOINTDelete an existing webhook endpoint from Breezy HR. Use this action when you need to remove a webhook endpoint that is no longer needed for receiving real-time notifications about Breezy HR events such as candidate additions, deletions, or status updates. This action is irreversible — the webhook endpoint cannot be recovered once deleted.Input Parameters
Output
Get Candidate
Get Candidate
BREEZY_HR_GET_CANDIDATERetrieve candidate details by ID for a given position in Breezy HR. Use this action when you need to fetch the full profile and details of a specific candidate applying to a specific job position. This includes contact information, social accounts, recruitment stage, rating, source, and other candidate metadata. This is a read-only operation that does not modify any candidate data.Input Parameters
Output
Get Candidate Conversation
Get Candidate Conversation
BREEZY_HR_GET_CANDIDATE_CONVERSATIONRetrieve the conversation stream for a specific candidate applying to a position. Use when you need to view all messages exchanged with a candidate, including messages sent by the hiring team and responses from the candidate. The conversation includes timestamps, message content, attachments, and sender information.Input Parameters
Output
Get Candidate Meta
Get Candidate Meta
BREEZY_HR_GET_CANDIDATE_METARetrieves candidate meta data by ID for a given position. Use this action when you need to fetch all metadata information (assessments, documents, scorecards, etc.) associated with a specific candidate for a specific job position. The metadata includes various aspects of the candidate’s interaction and evaluation such as assessments, background checks, conversation history, documents, questionnaires, references, schedule, scorecards, stream activity, tasks, and team notes.Input Parameters
Output
Get Candidate Resume
Get Candidate Resume
BREEZY_HR_GET_CANDIDATE_RESUMERetrieve a candidate’s resume file from a specific job position in Breezy HR. Use this action when you need to download and review a candidate’s resume/CV for a specific job application. The resume is typically returned as a PDF or Word document. This action streams the resume file directly from Breezy HR’s servers.Input Parameters
Output
Get Candidate Stream
Get Candidate Stream
BREEZY_HR_GET_CANDIDATE_STREAMRetrieves the last 50 candidate discussion stream events by candidate ID for a given position. Use this action when you need to view the conversation history, activity timeline, status changes, or all interactions related to a specific candidate within a job position. This is useful for tracking candidate engagement, reviewing hiring team notes, or monitoring the progression through the pipeline.Input Parameters
Output
Get Company Information
Get Company Information
Get Pipeline
Get Pipeline
Get Position
Get Position
Get Position Team
Get Position Team
BREEZY_HR_GET_POSITION_TEAMRetrieves user objects of all team members assigned to a specific job position. Use this action when you need to view the hiring team members associated with a particular position, including their names, email addresses, usernames, roles (Hiring Team Member or Hiring Manager), and account details. This is useful for understanding who has access to and responsibility for a specific job posting in your Breezy HR account.Input Parameters
Output
Get Questionnaire
Get Questionnaire
BREEZY_HR_GET_QUESTIONNAIRERetrieves a questionnaire by its ID for a specific company. Use this action when you need to fetch the details, questions, and settings of an existing questionnaire in Breezy HR.Input Parameters
Output
Get Email Template
Get Email Template
BREEZY_HR_GET_TEMPLATERetrieves an email template by its ID for a specific company. Use this action when you need to fetch the details, subject line, body content, and settings of an existing email template in Breezy HR.Input Parameters
Output
Get User
Get User
BREEZY_HR_GET_USERRetrieve the authenticated user’s profile from Breezy HR. The action accepts an optional user ID as a query parameter, but the endpoint returns the authenticated user’s profile.Input Parameters
Output
Get User Details
Get User Details
BREEZY_HR_GET_USER_DETAILSRetrieves the details for the configurations of each company the authenticated user belongs to. This includes company information, hiring pipelines, questionnaires, templates, tasks, scorecards, and team member data. Use this action when you need to fetch comprehensive user and company configuration data for the authenticated user across all accessible companies.Output
Get Webhook Endpoint
Get Webhook Endpoint
BREEZY_HR_GET_WEBHOOK_ENDPOINTRetrieves detailed information about a specific webhook endpoint by its ID. Use this action when you need to fetch details about an existing webhook endpoint, including its configuration, subscribed events, status, and delivery statistics. This is a read-only operation that does not modify any data.Input Parameters
Output
List Candidate Assessments
List Candidate Assessments
BREEZY_HR_LIST_CANDIDATE_ASSESSMENTSRetrieves all 3rd party assessments a candidate has taken for a specific position. Use this action when you need to: - View the assessment history for a specific candidate - Check the status of ongoing or pending assessments - Retrieve assessment results and reports - Verify candidate has completed required pre-employment assessments This action queries the Breezy HR API to get all assessments associated with a candidate within a specific position and company context.Input Parameters
Output
List Candidate Background Checks
List Candidate Background Checks
BREEZY_HR_LIST_CANDIDATE_BACKGROUND_CHECKSRetrieves all 3rd party background checks for a candidate. Use this action when you need to: - View the background check history for a specific candidate - Check the status of ongoing background checks - Retrieve background check results and reports This action queries the Breezy HR API to get all background checks associated with a candidate within a specific position and company context.Input Parameters
Output
List candidate custom attributes
List candidate custom attributes
BREEZY_HR_LIST_CANDIDATE_CUSTOM_ATTRIBUTESRetrieves all candidate-specific custom attributes configured for a company. Use this action when you need to list all available custom fields that can be used to store additional candidate information beyond the standard Breezy HR candidate fields. These custom attributes can include things like desired salary, source of application, department preferences, or any other company-specific data points. This is a read-only operation that does not modify any data.Input Parameters
Output
List Candidate Custom Fields
List Candidate Custom Fields
BREEZY_HR_LIST_CANDIDATE_CUSTOM_FIELDSRetrieves all custom field values for a specific candidate in the context of a job position. Use when you need to get the values of custom fields that have been filled out for a candidate in a specific job application, such as source of application, desired salary, department preference, or any other company-defined custom data points. This is a read-only operation that does not modify any data.Input Parameters
Output
List Candidate Documents
List Candidate Documents
BREEZY_HR_LIST_CANDIDATE_DOCUMENTSRetrieve candidate documents by candidate ID for a given position. Use when you need to list all documents associated with a specific candidate for a specific job position. The documents may include resumes, cover letters, portfolios, or other relevant files.Input Parameters
Output
List Candidate Questionnaires
List Candidate Questionnaires
BREEZY_HR_LIST_CANDIDATE_QUESTIONNAIRESRetrieves all questionnaires for a specific candidate. Use this action when you need to: - View all questionnaires associated with a candidate - Check the status of questionnaire submissions - Retrieve questionnaire completion dates and scores - Track pending or overdue questionnaires This action queries the Breezy HR API to get all questionnaires associated with a candidate within a specific position and company context.Input Parameters
Output
List Companies
List Companies
List Company Pipelines
List Company Pipelines
List Position Custom Attributes
List Position Custom Attributes
BREEZY_HR_LIST_POSITION_CUSTOM_ATTRIBUTESRetrieve all position-specific custom attributes defined for a company in Breezy HR. Use this action when you need to discover what custom fields are available for job positions, such as for building forms, validating attribute values, or understanding position data structure.Input Parameters
Output
List Position Custom Fields
List Position Custom Fields
BREEZY_HR_LIST_POSITION_CUSTOM_FIELDSRetrieve all custom fields for a specific position in Breezy HR. Use this action when you need to fetch the custom field values assigned to a particular job position, such as when reviewing candidate applications or updating position details. This action retrieves the custom field values (name, value, and security flag) that are associated with the specified position.Input Parameters
Output
List Breezy HR Positions
List Breezy HR Positions
BREEZY_HR_LIST_POSITIONSRetrieves all job positions for a specified company, optionally filtered by state. Use when you need to find available job openings, list company positions, or get position details for a Breezy HR company account. The state filter defaults to ‘published’ to return only active job listings.Input Parameters
Output
List company questionnaires
List company questionnaires
List Company Templates
List Company Templates
BREEZY_HR_LIST_TEMPLATESRetrieves all company email templates from Breezy HR. Use this action when you need to fetch all available email templates associated with a specific company in the Breezy HR system. This is useful for finding templates to use in candidate communications, customizing email workflows, or managing company communication templates.Input Parameters
Output
List Webhook Endpoints
List Webhook Endpoints
Pause Webhook Endpoint
Pause Webhook Endpoint
Resume Webhook Endpoint
Resume Webhook Endpoint
BREEZY_HR_RESUME_WEBHOOK_ENDPOINTResume webhook delivery to a paused endpoint in Breezy HR. Use when you need to resume webhook delivery to an endpoint that was previously paused. Once resumed, the endpoint will start receiving webhook notifications for subscribed events again.Input Parameters
Output
Search Candidates by Email
Search Candidates by Email
BREEZY_HR_SEARCH_CANDIDATESSearch for candidates by their email address across all positions in a company. Use when you need to find candidates with a specific email address, verify if a candidate exists in the system, or retrieve candidate information based on email. This is a read-only operation that searches across all positions and pipelines.Input Parameters
Output
Update Candidate
Update Candidate
BREEZY_HR_UPDATE_CANDIDATETool to update a candidate on a specific position in Breezy HR. Use when you need to modify candidate information such as their headline, contact details, social profiles, tags, or other details on an existing candidate application. The candidate must already exist for the specified position. This action makes a PUT request to update the candidate’s information.Input Parameters
Output
Update candidate scorecard
Update candidate scorecard
BREEZY_HR_UPDATE_CANDIDATE_SCORECARDUpdate a candidate’s scorecard for a specific position in a company. Use this action when you need to record a candidate’s evaluation score and optional notes during the hiring process. This action is idempotent — calling it multiple times with the same parameters will update (not duplicate) the scorecard.Input Parameters
Output
Update Candidate Stage
Update Candidate Stage
BREEZY_HR_UPDATE_CANDIDATE_STAGEMove a candidate to a specified stage in the hiring pipeline. Use when you need to advance, move, or reassign a candidate to a different stage in the recruitment process (e.g., from ‘applied’ to ‘interviewing’, or ‘interviewing’ to ‘offer’). The action requires the company ID, position ID, candidate ID, and the target stage ID.Input Parameters
Output
Update Position
Update Position
BREEZY_HR_UPDATE_POSITIONUpdate supported details of an existing Breezy HR position, such as its name, description, department, employment type, category, requirements, location, and tags.Input Parameters
Output
Update position state
Update position state
BREEZY_HR_UPDATE_POSITION_STATEUpdate the state of an existing position in Breezy HR. Use when you need to change a position’s workflow state (e.g., from draft to published, or closing a position after hiring is complete). This action is commonly used during recruitment workflow management.Input Parameters
Output
Update Webhook Endpoint
Update Webhook Endpoint
BREEZY_HR_UPDATE_WEBHOOK_ENDPOINTUpdate an existing webhook endpoint to receive event notifications from Breezy HR. Use when you need to modify the configuration of an existing webhook endpoint, such as changing the target URL, updating the description, modifying subscribed events, or enabling/disabling the endpoint. The endpoint must already exist for the specified company. This action makes a PUT request to update the webhook endpoint’s configuration.