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.

Untrusted display-only summary

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…

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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 cand…

Untrusted display-only summary

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 'a…

Untrusted display-only summary

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…

Untrusted display-only summary

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 s…

Untrusted display-only summary

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 re…

Untrusted display-only summary

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…

Untrusted display-only summary

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.

Untrusted display-only summary

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…

Untrusted display-only summary

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.

Untrusted display-only summary

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,…

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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 u…

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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 authe…

Untrusted display-only summary

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.

Untrusted display-only summary

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-employ…

Untrusted display-only summary

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 as…

Untrusted display-only summary

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, sourc…

Untrusted display-only summary

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 c…

Untrusted display-only summary

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.

Untrusted display-only summary