Breezy HR icon

Breezy HR

Applicant tracking and recruiting platform for posting jobs, sourcing candidates, and hiring.

4 searches5 actionsPollingAuth: OAuth

AI-assisted documentation9 min read

This documentation is compiled from our integration source code, internal specs for Breezy HR, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Breezy HR on WEXTL →

Breezy HR requires an active account and OAuth client credentials, granted by signing in with your account to connect — both are set up on its own site.[3]

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • EmailemailRequired

    Your email address.

    [1]
  • PasswordtextRequired

    Your password.

    [1]
  1. Log in to your WEXTL account, add the Breezy HR node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Breezy HR account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Breezy HR to WEXTL®
Video slide demonstrates how to integrate Breezy HR in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Get a CandidateAction
Input fields[3]
FieldType
Company IDRequired
choice
Output fields[3]
FieldType
IDtext
Meta IDtext
Addresstext
Assigned Toobject
Cover Lettertext
Creation Datetext
Educationarray
Email Addresstext
Followed Byobject
< User ID>text
Headlinetext
Initialtext
Nametext
Origintext
Overall Scoreobject
Very Goodarray
Goodarray
Neutralarray
Poorarray
Very Poorarray
Scored Countnumber
Scorenumber
Phone Numbertext
Profile Photo Urltext
Questionnaireobject
Recruited Byobject
IDtext
Email Addresstext
Nametext
Referred Byobject
IDtext
Email Addresstext
Nametext
Sourced Byobject
IDtext
Email Addresstext
Nametext
11other output fields
Get a PositionAction
Input fields[3]
FieldType
Company IDRequired
choice
Output fields[3]
FieldType
IDtext
Typeobject
IDtext
Nametext
Statetext
Nametext
Friendly IDtext
Experienceobject
IDtext
Nametext
Locationobject
Countryobject
Stateobject
Citytext
Nametext
Is Remoteboolean
Educationtext
Departmenttext
Requisition IDtext
Descriptiontext
Categoryobject
IDtext
Nametext
Application Formobject
Nametext
Headlinetext
Summarytext
Profile Phototext
Addresstext
Email Addresstext
Phone Numbertext
Resumetext
Work Historytext
Educationtext
Creator IDtext
Creation Datetext
Updated Datetext
Questionnaire IDtext
Scorecard IDtext
All Usersarray
All Adminsarray
6other output fields
Search CandidatesSearch
Input fields[3]
FieldType
Company IDRequired
choice
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Meta IDtext
Addresstext
Assigned Toobject
Cover Lettertext
Creation Datetext
Educationarray
Email Addresstext
Followed Byobject
< User ID>text
Headlinetext
Initialtext
Nametext
Origintext
Overall Scoreobject
Very Goodarray
Goodarray
Neutralarray
Poorarray
Very Poorarray
Scored Countnumber
Scorenumber
Phone Numbertext
Profile Photo Urltext
Questionnaireobject
Recruited Byobject
IDtext
Email Addresstext
Nametext
Referred Byobject
IDtext
Email Addresstext
Nametext
Sourced Byobject
IDtext
Email Addresstext
Nametext
11other output fields
Search PositionsSearch
Input fields[3]
FieldType
Company IDRequired
choice
Statechoice
Limitnumber
Output fields[3]
FieldType
IDtext
Typeobject
IDtext
Nametext
Statetext
Nametext
Friendly IDtext
Experienceobject
IDtext
Nametext
Locationobject
Countryobject
Stateobject
Citytext
Nametext
Is Remoteboolean
Educationtext
Departmenttext
Requisition IDtext
Descriptiontext
Categoryobject
IDtext
Nametext
Application Formobject
Nametext
Headlinetext
Summarytext
Profile Phototext
Addresstext
Email Addresstext
Phone Numbertext
Resumetext
Work Historytext
Educationtext
Creator IDtext
Creation Datetext
Updated Datetext
Questionnaire IDtext
Scorecard IDtext
All Usersarray
All Adminsarray
6other output fields
Create a CandidateAction
Input fields[3]
FieldType
Company IDRequired
choice
NameRequired
text
Email Addressemail
Phone Numbertext
Addresstext
Summarytext
Tagsarray
Originchoice
Sourcetext
Work Historyarray
Educationarray
Custom Attributesarray
Cover Lettertext
Output fields[3]
FieldType
IDtext
Meta IDtext
Addresstext
Assigned Toobject
Cover Lettertext
Creation Datetext
Educationarray
Email Addresstext
Followed Byobject
< User ID>text
Headlinetext
Initialtext
Nametext
Origintext
Overall Scoreobject
Very Goodarray
Goodarray
Neutralarray
Poorarray
Very Poorarray
Scored Countnumber
Scorenumber
Phone Numbertext
Profile Photo Urltext
Questionnaireobject
Recruited Byobject
IDtext
Email Addresstext
Nametext
Referred Byobject
IDtext
Email Addresstext
Nametext
Sourced Byobject
IDtext
Email Addresstext
Nametext
11other output fields
Create a PositionAction
Input fields[3]
FieldType
Company IDRequired
choice
NameRequired
text
DescriptionRequired
text
TypeRequired
choice
Departmenttext
Requisition IDtext
Categorychoice
Experiencechoice
Educationchoice
Custom Attributesarray
Scorecard IDtext
Questionnaire IDtext
Tagsarray
Output fields[3]
FieldType
IDtext
Typeobject
IDtext
Nametext
Statetext
Nametext
Friendly IDtext
Experienceobject
IDtext
Nametext
Locationobject
Countryobject
Stateobject
Citytext
Nametext
Is Remoteboolean
Educationtext
Departmenttext
Requisition IDtext
Descriptiontext
Categoryobject
IDtext
Nametext
Application Formobject
Nametext
Headlinetext
Summarytext
Profile Phototext
Addresstext
Email Addresstext
Phone Numbertext
Resumetext
Work Historytext
Educationtext
Creator IDtext
Creation Datetext
Updated Datetext
Questionnaire IDtext
Scorecard IDtext
All Usersarray
All Adminsarray
6other output fields
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Update a CandidateAction
Input fields[3]
FieldType
Company IDRequired
choice
Nametext
Email Addressemail
Phone Numbertext
Addresstext
Summarytext
Tagsarray
Originchoice
Sourcetext
Work Historyarray
Educationarray
Custom Attributesarray
Cover Lettertext
Output fields[3]
FieldType
IDtext
Typeobject
IDtext
Nametext
Statetext
Nametext
Friendly IDtext
Experienceobject
IDtext
Nametext
Locationobject
Countryobject
Stateobject
Citytext
Nametext
Is Remoteboolean
Educationtext
Departmenttext
Requisition IDtext
Descriptiontext
Categoryobject
IDtext
Nametext
Application Formobject
Nametext
Headlinetext
Summarytext
Profile Phototext
Addresstext
Email Addresstext
Phone Numbertext
Resumetext
Work Historytext
Educationtext
Creator IDtext
Creation Datetext
Updated Datetext
Questionnaire IDtext
Scorecard IDtext
All Usersarray
All Adminsarray
6other output fields
Update a PositionAction
Input fields[3]
FieldType
Company IDRequired
choice
Nametext
Descriptiontext
Typechoice
Departmenttext
Requisition IDtext
Categorychoice
Experiencechoice
Educationchoice
Custom Attributesarray
Scorecard IDtext
Questionnaire IDtext
Tagsarray
Output fields[3]
FieldType
IDtext
Typeobject
IDtext
Nametext
Statetext
Nametext
Friendly IDtext
Experienceobject
IDtext
Nametext
Locationobject
Countryobject
Stateobject
Citytext
Nametext
Is Remoteboolean
Educationtext
Departmenttext
Requisition IDtext
Descriptiontext
Categoryobject
IDtext
Nametext
Application Formobject
Nametext
Headlinetext
Summarytext
Profile Phototext
Addresstext
Email Addresstext
Phone Numbertext
Resumetext
Work Historytext
Educationtext
Creator IDtext
Creation Datetext
Updated Datetext
Questionnaire IDtext
Scorecard IDtext
All Usersarray
All Adminsarray
6other output fields

Look for Breezy HR templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Breezy HR Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Breezy HR.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:38