Your AI team, working in Breezy Hr

Integrate Breezy HR to streamline your recruiting and applicant tracking processes.

Start your company

What your team can do in Breezy Hr

48 tools to work with, connected with an API key.

Add Candidate Custom Attribute

Add or update a custom attribute for a candidate on a position in Breezy HR. An existing attribute is matched by both its name and secure flag.

Add Candidate Document

Upload 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.

Add Candidate Education

Add an education entry to an existing candidate on a position in Breezy HR. The entry is appended to the candidate's education history.

Add Candidate Note

Adds 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.

Add candidate resume

Upload 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.

Add candidate to position

Add 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.

Add Candidate Work History

Add 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.

Create Candidate From Resume

Upload 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.

Create Position

Create a new Breezy HR position for a company with details such as title, description, location, and employment type.

Create Webhook Endpoint

Create 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.

Delete Webhook Endpoint

Delete 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.

Get CandidateReads only

Retrieve 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.

Get Candidate ConversationReads only

Retrieve 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.

Get Candidate MetaReads only

Retrieves 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.

Get Candidate ResumeReads only

Retrieve 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.

Get Candidate StreamReads only

Retrieves 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.

Get Company InformationReads only

Retrieve a company's public profile in Breezy HR by company ID. The returned fields are limited by the action's response model.

Get Email TemplateReads only

Retrieves 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.

Get PipelineReads only

Retrieves pipeline stages by pipeline ID for a specified company. Use when you need to fetch the hiring workflow stages associated with a particular pipeline, including stage names, icons, action counts, and associated actions.

Get PositionReads only

Retrieve details of a specific Breezy HR position by company and position ID. The action returns selected position fields rather than the complete position record.

Get Position TeamReads only

Retrieves 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.

Get QuestionnaireReads only

Retrieves 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.

Get UserReads only

Retrieve 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.

Get User DetailsReads only

Retrieves 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.

Get Webhook EndpointReads only

Retrieves 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.

List Breezy HR PositionsReads only

Retrieves 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.

List Candidate AssessmentsReads only

Retrieves 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.

List Candidate Background ChecksReads only

Retrieves 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.

List candidate custom attributesReads only

Retrieves 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.

List Candidate Custom FieldsReads only

Retrieves 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.

List Candidate DocumentsReads only

Retrieve 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.

List Candidate QuestionnairesReads only

Retrieves 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.

List CompaniesReads only

Retrieve the companies associated with the authenticated user. Use this action when you need to discover what companies are accessible to the authenticated user, such as for listing available workspaces or checking company details.

List Company PipelinesReads only

Retrieve the hiring pipelines configured for a Breezy HR company. The result is keyed by pipeline name and includes each pipeline's ordered stages.

List company questionnairesReads only

Retrieves all company questionnaires from Breezy HR. Use this action when you need to fetch all available questionnaires associated with a specific company in the Breezy HR system.

List Company TemplatesReads only

Retrieves 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.

List Position Custom AttributesReads only

Retrieve 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.

List Position Custom FieldsReads only

Retrieve 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.

List Webhook EndpointsReads only

List webhook endpoints configured for a specified Breezy HR company to review their event subscriptions and configuration. This is a read-only operation.

Pause Webhook Endpoint

Pause webhook delivery to a Breezy HR endpoint without deleting its configuration. The endpoint can be resumed later; pausing sets its status to paused and enabled to false.

Resume Webhook Endpoint

Resume 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.

Search Candidates by EmailReads only

Search 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.

Update Candidate

Tool 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.

Update candidate scorecard

Update 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.

Update Candidate Stage

Move 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.

Update Position

Update supported details of an existing Breezy HR position, such as its name, description, department, employment type, category, requirements, location, and tags.

Update position state

Update 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.

Update Webhook Endpoint

Update 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.

More in HR talent & recruitment

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or