BreezyHR

Get information about the authenticated user or another user by ID

Get detailed information about the currently authenticated user

Sign out the current user and invalidate the access token

Get all companies accessible to the authenticated user

Get detailed information about a specific company

Get custom attribute definitions for candidates in a company

Get custom attribute definitions for positions in a company

Get all positions/jobs for the company

Get details of a specific position by ID

Create a new job position

Update details for a given position

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

Get activity stream for a position

Get team members assigned to a position

Get custom field values for a position. Only returns fields that already have values set on the position.

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

Get all candidates for a specific position with abbreviated candidate objects

Retrieve all candidates with entered email address across all positions

Get detailed information about a specific candidate

Add a new candidate to a position

Update candidate information

Move a candidate from one position to another

Move candidate to a different stage in the hiring pipeline

Get activity stream/timeline for a candidate

Add a note to candidate’s discussion stream

Get metadata information for a candidate

Get the resume file for a candidate

Get all documents attached to a candidate

Get email conversation thread for a candidate

Add a new conversation message for the candidate

Add an education entry to a candidate

Add a work history entry to a candidate

Get questionnaires submitted by a candidate

Send a questionnaire to a candidate

Update scorecard/evaluation for a candidate

Get assessment results for a candidate

Get background check results for a candidate

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

Get custom field values for a candidate. Returns fields defined at company level with their per-candidate values.

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

Get all hiring pipelines for a company

Get details of a specific hiring pipeline

Get all questionnaires for a company

Get details of a specific questionnaire

Update or submit questionnaire responses for a candidate

Get all email and message templates for a company

Get details of a specific email or message template

Emitted when a new candidate is added to a position. Maps to BreezyHR event candidateAdded.

Emitted when a candidate is deleted from a position. Maps to BreezyHR event candidateDeleted.

Emitted when a candidate’s status changes within a position’s pipeline. Maps to BreezyHR event candidateStatusUpdated.

Emitted when a new position is created in the company. Maps to BreezyHR event companyPositionAdded.

Emitted when a position’s details are updated. Maps to BreezyHR event companyPositionUpdated.

Emitted when a position is deleted from the company. Maps to BreezyHR event companyPositionDeleted.

Emitted when a position’s state changes (e.g. draft, published, closed, archived). Maps to BreezyHR event `companyPositi…

Emitted when a new note is posted in the company. Maps to BreezyHR event companyNotePosted.

Emitted when a note is updated in the company. Maps to BreezyHR event companyNoteUpdated.

Emitted when a note is deleted from the company. Maps to BreezyHR event companyNoteDeleted.

Emitted when a new candidate is added to a position. Maps to BreezyHR event candidateAdded.

Emitted when a candidate is deleted from a position. Maps to BreezyHR event candidateDeleted.

Emitted when a candidate’s status changes within a position’s pipeline. Maps to BreezyHR event candidateStatusUpdated.

Emitted when a new position is created in the company. Maps to BreezyHR event companyPositionAdded.

Emitted when a position’s details are updated. Maps to BreezyHR event companyPositionUpdated.

Emitted when a position is deleted from the company. Maps to BreezyHR event companyPositionDeleted.

Emitted when a position’s state changes (e.g. draft, published, closed, archived). Maps to BreezyHR event `companyPositi…

Emitted when a new note is posted in the company. Maps to BreezyHR event companyNotePosted.

Emitted when a note is updated in the company. Maps to BreezyHR event companyNoteUpdated.

Emitted when a note is deleted from the company. Maps to BreezyHR event companyNoteDeleted.