Breezy Hr

Add or update a custom attribute for a candidate in Breezy HR. Use when you need to store custom metadata, internal notes, evaluation scores, or any other custom data for a candidate application. If the attribute name already exists for this candidate, its value will be updated with the new value.

Upload a document file for an existing candidate in Breezy HR. Use when you need to attach additional documents (cover letters, portfolios, certifications, or other files) to a candidate's application. The file is sent as multipart/form-data with the field name 'data'. This action is idempotent - uploading a document with the same name may create a duplicate or update the existing document depending on Breezy HR behavior.

Add an education entry to an existing candidate in Breezy HR. Use this action when you need to record a candidate's educational background, such as degrees, certifications, or school attendance. If an education entry already exists for the same school, it will be updated with the provided values.

This action adds a note to a candidate's discussion stream in Breezy HR. It allows you to record feedback, observations, or communication about a candidate that will be visible in their activity history.

Attach a resume file to an existing candidate in Breezy HR. Use when you need to add or update a candidate's resume document. The file is sent as multipart/form-data with the field name 'file'.

Add a work history entry to an existing candidate in Breezy HR. Use this action when you need to record a candidate's employment history, such as previous job positions, companies, and work responsibilities. If a work history entry already exists for the same company, it will be updated with the provided values.

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.

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 a new position in Breezy HR. Use when you need to add a new job opening to your company's hiring pipeline with specific details like title, description, location, and employment type. This action creates a position that can then accept applications from candidates. The position will be created in draft state by default unless otherwise specified.

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

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.

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.

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.

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.

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.

Retrieves complete information about a company in Breezy HR. Use when you need to fetch company details, settings, or profile information for a specific Breezy HR company account.

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.

Retrieves detailed information about a specific job position by its ID. Use this action when you have a company ID and position ID and need to fetch the complete position details including description, location, requirements, and settings.

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.

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.

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.

Retrieves information about the authenticated user or a specific user by ID. Use this action when you need to fetch user profile details, including name, email, role, and other account information from Breezy HR. If user_id is not provided, the action returns the currently authenticated user's information.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Retrieve all pipelines for a company. Use this action when you need to list all hiring pipelines configured in a Breezy HR company account. This action is read-only and returns pipeline information including stages, positions, and settings.

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.

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.

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.

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.

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.

Retrieves all webhook endpoints configured for a specified company in Breezy HR. Use when you need to list all registered webhook endpoints, audit which events are being monitored, or check the configuration of existing webhooks. This action is read-only and idempotent.

Pause webhook delivery to an endpoint in Breezy HR. Use when you need to temporarily stop receiving webhook notifications without deleting the endpoint configuration. The endpoint remains configured and can be resumed later. This action is useful during maintenance windows, debugging scenarios, or when you need to temporarily halt webhook processing while keeping the endpoint configuration intact. The endpoint status changes to 'paused' while the 'enabled' flag remains true, allowing for easy resumption.

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

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

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.

Tool to update details of an existing position in Breezy HR. Use when you need to modify any attributes of an existing job position such as the name, description, department, employment type, category, education requirements, experience level, location, tags, or other position properties. The position must already exist for the specified company. This action makes a PUT request to update the position's information.

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