BreezyHR - Stackone

Getting Started

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

Basic Auth · Connector Profile

Connect using your BreezyHR administrator email and password.

API Key · Connector Profile

Uses an API key (a personal access token) created under My Settings > API Keys in BreezyHR. The key inherits the permiss…

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Basic Auth · Link Account

API Key · Link Account

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

47 actions

Action

Description

Get User

Get information about the authenticated user or another user by ID

Get User Details

Get detailed information about the currently authenticated user

Sign Out

Sign out the current user and invalidate the session token

List Companies

Get all companies accessible to the authenticated user

Get Company Details

Get detailed information about a specific company

Get Candidate Custom Attributes

Get custom attribute definitions for candidates in a company

Get Position Custom Attributes

Get custom attribute definitions for positions in a company

List All Positions

Get all positions/jobs for the company

Get A Specific Position

Get details of a specific position by ID

Create A New Position

Create a new job position

Update A Position

Update details for a given position

Update Position State

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

Get Position Activity Stream

Get activity stream for a position

Get Position Team Members

Get team members assigned to a position

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

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

List Position Candidates

Get all candidates for a specific position with abbreviated candidate objects

Search Candidates By Email

Retrieve all candidates with entered email address across all positions

Get Candidate Details

Get detailed information about a specific candidate

Create Candidate

Add a new candidate to a position

Update Candidate

Update candidate information

Move Candidate To Another Position

Move a candidate from one position to another

Update Candidate Stage

Move candidate to a different stage in the hiring pipeline

Get Candidate Activity Stream

Get activity stream/timeline for a candidate

Add Note To Candidate Stream

Add a note to candidate’s discussion stream

Get Candidate Metadata

Get metadata information for a candidate

Get Candidate Resume

Get the resume file for a candidate

Get Candidate Documents

Get all documents attached to a candidate

Get Candidate Conversation

Get email conversation thread for a candidate

Send Message To Candidate

Add a new conversation message for the candidate

Add Candidate Education Entry

Add an education entry to a candidate

Add Candidate Work History Entry

Add a work history entry to a candidate

Get Candidate Questionnaires

Get questionnaires submitted by a candidate

Send Questionnaire To Candidate

Send a questionnaire to a candidate

Update Candidate Scorecard

Update scorecard/evaluation for a candidate

Get Candidate Assessments

Get assessment results for a candidate

Get Candidate Background Checks

Get background check results for a candidate

Add Candidate Custom Attribute

Add or update a custom attribute on a candidate. This is different from update_candidate_custom_field.

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

Update a specific custom field value for a candidate. Use get_candidate_custom_fields to get the custom_field_id.

List Pipelines

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

Get Pipeline Details

Get details of a specific hiring pipeline

List Questionnaires

Get all questionnaires for a company

Get Questionnaire Details

Get details of a specific questionnaire

Update Questionnaire Response

Update or submit questionnaire responses for a candidate

List Templates

Get all email and message templates for a company

Get Template Details

Get details of a specific email or message template

Events

10 events

Event